Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::rtc::IMediaPlayerSourceObserver Class Referenceabstract

Public Member Functions

virtual ~IMediaPlayerSourceObserver ()
 
virtual void onPlayerSourceStateChanged (media::base::MEDIA_PLAYER_STATE state, media::base::MEDIA_PLAYER_ERROR ec)=0
 
virtual void onPositionChanged (int64_t position)=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 onCompleted ()=0
 

Detailed Description

This class class reports runtime events to the applications.

Constructor & Destructor Documentation

◆ ~IMediaPlayerSourceObserver()

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

Member Function Documentation

◆ onPlayerSourceStateChanged()

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

Reports the playback state change.

When the state of the playback changes, the SDK triggers this callback to report the new playback state and the reason or error for the change.

Parameters
stateThe new playback state after change. See MEDIA_PLAYER_STATE.
ecThe player's error code. See MEDIA_PLAYER_ERROR.

◆ onPositionChanged()

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

Reports current playback progress.

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

Parameters
positionCurrent playback progress (second).

◆ 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 SDK triggers the callback to report the results of the seek operation.
  • After calling the selectAudioTrack method, the SDK triggers the callback to report that the audio track changes.
Parameters
eventThe playback event. See MEDIA_PLAYER_EVENT.

◆ onMetaData()

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

Occurs when the metadata is received.

The callback occurs when the player receives 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

Triggered when play buffer updated, once every 1 second.

Parameters
intcached buffer during playing, in milliseconds

◆ onCompleted()

virtual void agora::rtc::IMediaPlayerSourceObserver::onCompleted ( )
pure virtual

Occurs when one playback of the media file is completed.