Media Player Kit v1.3.0 API Reference for Windows
Public Member Functions | List of all members
agora::rtc::IMediaPlayerSourceObserver Class Referenceabstract

Public Member Functions

virtual ~IMediaPlayerSourceObserver ()=default
 
virtual void onPlayerSourceStateChanged (media::base::MEDIA_PLAYER_STATE state, media::base::MEDIA_PLAYER_ERROR ec)=0
 
virtual void onPositionChanged (int64_t position_ms)=0
 
virtual void onPlayerEvent (media::base::MEDIA_PLAYER_EVENT event)=0
 
virtual void onMetaData (const void *data, int length)=0
 
virtual void onPlayBufferUpdated (int64_t playCachedBuffer)=0
 
virtual void onPreloadEvent (const char *src, media::base::PLAYER_PRELOAD_EVENT event)=0
 

Constructor & Destructor Documentation

◆ ~IMediaPlayerSourceObserver()

virtual agora::rtc::IMediaPlayerSourceObserver::~IMediaPlayerSourceObserver ( )
virtualdefault

Member Function Documentation

◆ onPlayerSourceStateChanged()

virtual void agora::rtc::IMediaPlayerSourceObserver::onPlayerSourceStateChanged ( media::base::MEDIA_PLAYER_STATE  state,
media::base::MEDIA_PLAYER_ERROR  ec 
)
pure virtual

Triggered when the player state changes.

Parameters
stateNew player state
ecPlayer error message

◆ onPositionChanged()

virtual void agora::rtc::IMediaPlayerSourceObserver::onPositionChanged ( int64_t  position_ms)
pure virtual

Reports current playback progress.

The callback occurs once every one second during the playback and reports current playback progress.

Parameters
positionCurrent playback progress (ms).

◆ onPlayerEvent()

virtual void agora::rtc::IMediaPlayerSourceObserver::onPlayerEvent ( media::base::MEDIA_PLAYER_EVENT  event)
pure virtual

Reports the playback event.

  • After calling the seek method, the MediaPlayer Kit occurs the callback to report the results of the seek operation.
  • After calling the selectAudioTrack method, the MediaPlayer Kit occurs the callback to report that the audio track changes.
Parameters
eventThe playback event. See MEDIA_PLAYER_EVENT for details.

◆ onMetaData()

virtual void agora::rtc::IMediaPlayerSourceObserver::onMetaData ( const void *  data,
int  length 
)
pure virtual

Reports the reception of the media metadata.

The callback occurs when the player receivers the media metadata and reports the detailed information of the media metadata.

Parameters
dataThe detailed data of the media metadata.
lengthThe data length (bytes).

◆ onPlayBufferUpdated()

virtual void agora::rtc::IMediaPlayerSourceObserver::onPlayBufferUpdated ( int64_t  playCachedBuffer)
pure virtual

Reports the playback duration that the buffered data can support.

In the process of playing online media resources, the mediaplayer kit triggers this callback every one second to report the playback duration that the currently buffered data can support.

  • When the playback duration supported by the buffered data is less than the threshold (0 by default), the mediaplayer kit returns PLAYER_EVENT_BUFFER_LOW(6).
  • When the playback duration supported by the buffered data is greater than the threshold (0 by default), the mediaplayer kit returns PLAYER_EVENT_BUFFER_RECOVER(7).
    Parameters
    playCachedBufferThe playback duration (ms) that the buffered data can support.

◆ onPreloadEvent()

virtual void agora::rtc::IMediaPlayerSourceObserver::onPreloadEvent ( const char *  src,
media::base::PLAYER_PRELOAD_EVENT  event 
)
pure virtual

Triggered when the player addPreloadSrc.

Parameters
event