Agora RTC Objective-C API Reference  Refactor
IAgoraMediaPlayerSource.h
Go to the documentation of this file.
1 //
2 // Agora SDK
3 //
4 // Copyright (c) 2018 Agora.io. All rights reserved.
5 //
6 #pragma once // NOLINT(build/header_guard)
7 
8 #include "AgoraBase.h"
9 #include "AgoraMediaBase.h"
10 #include "AgoraMediaPlayerTypes.h"
11 #include "AgoraRefPtr.h"
12 
13 namespace agora {
14 namespace rtc {
15 
16 class IMediaPlayerSourceObserver;
17 
23 protected:
24  virtual ~IMediaPlayerSource() {}
25 
26 public:
27 
35  virtual int getSourceId() const = 0;
36 
46  virtual int open(const char* url, int64_t startPos) = 0;
47 
56  virtual int openWithMediaSource(const media::base::MediaSource &source) = 0;
57 
65  virtual int play() = 0;
66 
74  virtual int pause() = 0;
75 
83  virtual int stop() = 0;
84 
92  virtual int resume() = 0;
93 
102  virtual int seek(int64_t newPos) = 0;
103 
112  virtual int getDuration(int64_t& duration) = 0;
113 
122  virtual int getPlayPosition(int64_t& pos) = 0;
123 
132  virtual int getStreamCount(int64_t& count) = 0;
133 
143  virtual int getStreamInfo(int64_t index, media::base::PlayerStreamInfo* info) = 0;
144 
156  virtual int setLoopCount(int64_t loopCount) = 0;
157 
166  virtual int setPlaybackSpeed(int speed) = 0;
167 
176  virtual int selectAudioTrack(int64_t index) = 0;
177 
194  virtual int selectMultiAudioTrack(int playoutTrackIndex, int publishTrackIndex) = 0;
195 
205  virtual int setPlayerOption(const char* key, int64_t value) = 0;
206 
216  virtual int setPlayerOption(const char* key, const char* value) = 0;
217 
226  virtual int takeScreenshot(const char* filename) = 0;
227 
236  virtual int selectInternalSubtitle(int64_t index) = 0;
237 
246  virtual int setExternalSubtitle(const char* url) = 0;
247 
254 
266 
276 
286 
296 
309  virtual int openWithAgoraCDNSrc(const char* src, int64_t startPos) = 0;
310 
320  virtual int getAgoraCDNLineCount() = 0;
321 
322 
333  virtual int switchAgoraCDNLineByIndex(int index) = 0;
334 
344  virtual int getCurrentAgoraCDNIndex() = 0;
345 
356  virtual int enableAutoSwitchAgoraCDN(bool enable) = 0;
357 
369  virtual int renewAgoraCDNSrcToken(const char* token, int64_t ts) = 0;
370 
382  virtual int switchAgoraCDNSrc(const char* src, bool syncPts = false) = 0;
383 
393  virtual int switchSrc(const char* src, bool syncPts) = 0;
394 
404  virtual int preloadSrc(const char* src, int64_t startPos) = 0;
405 
414  virtual int unloadSrc(const char* src) = 0;
415 
424  virtual int playPreloadedSrc(const char* src) = 0;
425 
426 };
427 
432  public:
434 
448 
460  virtual void onPositionChanged(int64_t positionMs, int64_t timestampMs) = 0;
461 
474  virtual void onPlayerEvent(media::base::MEDIA_PLAYER_EVENT eventCode, int64_t elapsedTime, const char* message) = 0;
475 
487  virtual void onMetaData(const void* data, int length) = 0;
488 
489 
504  virtual void onPlayBufferUpdated(int64_t playCachedBuffer) = 0;
505 
506 
514  virtual void onPreloadEvent(const char* src, media::base::PLAYER_PRELOAD_EVENT event) = 0;
515 
519  virtual void onCompleted() = 0;
520 
527  virtual void onAgoraCDNTokenWillExpire() = 0;
528 
538  virtual void onPlayerSrcInfoChanged(const media::base::SrcInfo& from, const media::base::SrcInfo& to) = 0;
539 
551 
563  (void)stats;
564  }
565 
577  (void)stats;
578  }
579 
590  virtual void onAudioVolumeIndication(int volume) = 0;
591 };
592 
593 } //namespace rtc
594 } // namespace agora
agora::rtc::IMediaPlayerSourceObserver::onPlayerCacheStats
virtual void onPlayerCacheStats(const media::base::CacheStatistics &stats)
Reports the statistics of the media file being cached.
Definition: IAgoraMediaPlayerSource.h:562
agora::rtc::IMediaPlayerSource::getState
virtual media::base::MEDIA_PLAYER_STATE getState()=0
agora::rtc::IMediaPlayerSource::seek
virtual int seek(int64_t newPos)=0
agora::media::IAudioPcmFrameSink
Definition: AgoraMediaBase.h:1402
agora::rtc::IMediaPlayerSource::~IMediaPlayerSource
virtual ~IMediaPlayerSource()
Definition: IAgoraMediaPlayerSource.h:24
agora::rtc::IMediaPlayerSource::registerAudioFrameObserver
virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink *observer)=0
AgoraBase.h
agora::rtc::IMediaPlayerSource
Definition: IAgoraMediaPlayerSource.h:22
agora::media::base::CacheStatistics
Statistics about the media files being cached.
Definition: AgoraMediaPlayerTypes.h:423
agora::rtc::IMediaPlayerSourceObserver
Definition: IAgoraMediaPlayerSource.h:431
agora::rtc::IMediaPlayerSource::pause
virtual int pause()=0
agora::rtc::IMediaPlayerSourceObserver::onPlayerInfoUpdated
virtual void onPlayerInfoUpdated(const media::base::PlayerUpdatedInfo &info)=0
Occurs when information related to the media player changes.
agora::rtc::IMediaPlayerSource::switchAgoraCDNLineByIndex
virtual int switchAgoraCDNLineByIndex(int index)=0
agora::media::base::PlayerUpdatedInfo
Information related to the media player.
Definition: AgoraMediaPlayerTypes.h:463
agora::rtc::IMediaPlayerSource::switchAgoraCDNSrc
virtual int switchAgoraCDNSrc(const char *src, bool syncPts=false)=0
agora::media::base::MEDIA_PLAYER_EVENT
MEDIA_PLAYER_EVENT
Media player events.
Definition: AgoraMediaPlayerTypes.h:214
agora::rtc::IMediaPlayerSource::renewAgoraCDNSrcToken
virtual int renewAgoraCDNSrcToken(const char *token, int64_t ts)=0
agora::rtc::IMediaPlayerSource::play
virtual int play()=0
agora::rtc::IMediaPlayerSource::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(media::IAudioPcmFrameSink *observer)=0
agora::media::base::MEDIA_PLAYER_STATE
MEDIA_PLAYER_STATE
The playback state.
Definition: AgoraMediaPlayerTypes.h:53
agora::rtc::IMediaPlayerSourceObserver::onAgoraCDNTokenWillExpire
virtual void onAgoraCDNTokenWillExpire()=0
AgoraCDN Token has expired and needs to be set up with renewAgoraCDNSrcToken(const char* src).
agora::rtc::IMediaPlayerSource::getStreamCount
virtual int getStreamCount(int64_t &count)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IMediaPlayerSource::takeScreenshot
virtual int takeScreenshot(const char *filename)=0
agora::rtc::IMediaPlayerSourceObserver::onPlayerSourceStateChanged
virtual void onPlayerSourceStateChanged(media::base::MEDIA_PLAYER_STATE state, media::base::MEDIA_PLAYER_REASON reason)=0
Reports the changes of playback state.
agora::rtc::IMediaPlayerSourceObserver::~IMediaPlayerSourceObserver
virtual ~IMediaPlayerSourceObserver()
Definition: IAgoraMediaPlayerSource.h:433
agora::rtc::IMediaPlayerSource::resume
virtual int resume()=0
agora::rtc::IMediaPlayerSource::switchSrc
virtual int switchSrc(const char *src, bool syncPts)=0
agora::rtc::IMediaPlayerSource::setLoopCount
virtual int setLoopCount(int64_t loopCount)=0
agora::rtc::IMediaPlayerSource::registerPlayerSourceObserver
virtual int registerPlayerSourceObserver(IMediaPlayerSourceObserver *observer)=0
agora::rtc::IMediaPlayerSource::getSourceId
virtual int getSourceId() const =0
agora::rtc::IMediaPlayerSource::getPlayPosition
virtual int getPlayPosition(int64_t &pos)=0
agora::media::base::PlayerStreamInfo
The detailed information of the media stream.
Definition: AgoraMediaPlayerTypes.h:307
agora::rtc::IMediaPlayerSource::openWithAgoraCDNSrc
virtual int openWithAgoraCDNSrc(const char *src, int64_t startPos)=0
agora::rtc::IMediaPlayerSourceObserver::onPreloadEvent
virtual void onPreloadEvent(const char *src, media::base::PLAYER_PRELOAD_EVENT event)=0
Reports the events of preloaded media resources.
agora::rtc::IMediaPlayerSource::openWithMediaSource
virtual int openWithMediaSource(const media::base::MediaSource &source)=0
agora::rtc::IMediaPlayerSourceObserver::onMetaData
virtual void onMetaData(const void *data, int length)=0
Occurs when the media metadata is received.
agora::rtc::IMediaPlayerSource::unregisterPlayerSourceObserver
virtual int unregisterPlayerSourceObserver(IMediaPlayerSourceObserver *observer)=0
agora::rtc::IMediaPlayerSourceObserver::onPlayerSrcInfoChanged
virtual void onPlayerSrcInfoChanged(const media::base::SrcInfo &from, const media::base::SrcInfo &to)=0
Occurs when the video bitrate of the media resource changes.
agora::rtc::IMediaPlayerSourceObserver::onPlayerEvent
virtual void onPlayerEvent(media::base::MEDIA_PLAYER_EVENT eventCode, int64_t elapsedTime, const char *message)=0
Reports the player events.
agora::media::base::MediaSource
Information related to the media file to be played and the playback scenario configurations.
Definition: AgoraMediaPlayerTypes.h:560
agora::media::base::PlayerPlaybackStats
The information of the media file being played.
Definition: AgoraMediaPlayerTypes.h:441
agora::rtc::IMediaPlayerSource::selectAudioTrack
virtual int selectAudioTrack(int64_t index)=0
agora::rtc::IMediaPlayerSource::getStreamInfo
virtual int getStreamInfo(int64_t index, media::base::PlayerStreamInfo *info)=0
AgoraRefPtr.h
agora::rtc::IMediaPlayerSourceObserver::onAudioVolumeIndication
virtual void onAudioVolumeIndication(int volume)=0
Reports the volume of the media player.
agora::rtc::IMediaPlayerSource::unloadSrc
virtual int unloadSrc(const char *src)=0
AgoraMediaBase.h
agora::rtc::IMediaPlayerSource::selectMultiAudioTrack
virtual int selectMultiAudioTrack(int playoutTrackIndex, int publishTrackIndex)=0
AgoraMediaPlayerTypes.h
agora::rtc::IMediaPlayerSource::getDuration
virtual int getDuration(int64_t &duration)=0
agora::rtc::IMediaPlayerSource::setPlayerOption
virtual int setPlayerOption(const char *key, int64_t value)=0
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::media::base::SrcInfo
Information about the video bitrate of the media resource being played.
Definition: AgoraMediaPlayerTypes.h:393
agora::rtc::IMediaPlayerSource::playPreloadedSrc
virtual int playPreloadedSrc(const char *src)=0
agora::rtc::IMediaPlayerSource::setPlayerOption
virtual int setPlayerOption(const char *key, const char *value)=0
agora::rtc::IMediaPlayerSourceObserver::onPlayerPlaybackStats
virtual void onPlayerPlaybackStats(const media::base::PlayerPlaybackStats &stats)
The statistics of the media file being played.
Definition: IAgoraMediaPlayerSource.h:576
agora::rtc::IMediaPlayerSource::selectInternalSubtitle
virtual int selectInternalSubtitle(int64_t index)=0
agora::media::base::PLAYER_PRELOAD_EVENT
PLAYER_PRELOAD_EVENT
Events that occur when media resources are preloaded.
Definition: AgoraMediaPlayerTypes.h:289
agora::rtc::IMediaPlayerSourceObserver::onCompleted
virtual void onCompleted()=0
Occurs when one playback of the media file is completed.
agora::rtc::IMediaPlayerSource::setExternalSubtitle
virtual int setExternalSubtitle(const char *url)=0
agora::media::base::MEDIA_PLAYER_REASON
MEDIA_PLAYER_REASON
Reasons for the changes in the media player status.
Definition: AgoraMediaPlayerTypes.h:116
agora::rtc::IMediaPlayerSource::getCurrentAgoraCDNIndex
virtual int getCurrentAgoraCDNIndex()=0
agora::rtc::IMediaPlayerSource::setPlaybackSpeed
virtual int setPlaybackSpeed(int speed)=0
agora::rtc::IMediaPlayerSource::enableAutoSwitchAgoraCDN
virtual int enableAutoSwitchAgoraCDN(bool enable)=0
agora::rtc::IMediaPlayerSource::preloadSrc
virtual int preloadSrc(const char *src, int64_t startPos)=0
agora::rtc::IMediaPlayerSource::open
virtual int open(const char *url, int64_t startPos)=0
agora::rtc::IMediaPlayerSourceObserver::onPlayBufferUpdated
virtual void onPlayBufferUpdated(int64_t playCachedBuffer)=0
Reports the playback duration that the buffered data can support.
agora::rtc::IMediaPlayerSource::getAgoraCDNLineCount
virtual int getAgoraCDNLineCount()=0
agora::rtc::IMediaPlayerSourceObserver::onPositionChanged
virtual void onPositionChanged(int64_t positionMs, int64_t timestampMs)=0
Reports the playback progress of the media file.
agora::rtc::IMediaPlayerSource::stop
virtual int stop()=0