MediaPlayer Kit C++ API Reference

Overview IMediaPlayer IMediaPlayerObserver Error Codes

IMediaPlayer class provides the main methods that can be invoked by your application.
IMediaPlayerObserver class reports runtime events to the applications.

Main methods

Method	Description
createAgoraMediaPlayer	Creates the IMediaPlayer object.
initialize	Initializes the MediaPlayer Kit.
setLogFile	Sets the output path of the log file.
setLogFilter	Sets the output level of the log file.
release	Release the IMediaPlayer resource.
registerPlayerObserver	Registers a player observer.
unregisterPlayerObserver	Unregisters a player observer.
registerAudioFrameObserver	Registers an audio observer.
unregisterAudioFrameObserver	Unregisters an audio observer.
registerVideoFrameObserver	Registers a video observer.
unregisterVideoFrameObserver	Unregisters a video observer.
setView	Sets the player's render view.
setRenderMode	Sets the player's render mode.
open	Open the media resource.
setLoopCount	Sets the loop playback.
selectAudioTrack	Selects the audio track.
changePlaybackSpeed	Adjusts the playback speed.
play	Plays the media resource.
pause	Pauses the playback.
stop	Stops the playback.
seek	Seeks to a new playback position.
adjustPlayoutVolume	Adjusts the local playback volume.
mute	Sets whether to mute the media resource.
getDuration	Gets the duration of the media resource.
getPlayPosition	Gets current playback progress.
getPlayoutVolume	Gets current local playback volume.
getMute	Checks whether the media resource is muted.
getState	Gets current playback state.
getStreamCount	Gets the number of the media streams in the media resource.
getStreamInfo	Gets the detailed information of the media stream.
setExternalSubtitle	Sets the external subtitle.
switchSrc	Switches the media resource being played.
addPreloadSrc	Preloads media resources.
playPreload	Plays preloaded media resources.

Main events

Event	Description
onPlayerStateChanged	Reports the playback state change.
onPositionChanged	Reports current playback progress.
onPlayerEvent	Reports the playback events.
onMetadata	Reports the reception of the media metadata.
onPlayBufferUpdated	Reports the playback duration that the buffered data can support.
onPreloadEvent	Reports the events for preloading media resources.
onFrame	Occurs when each time the player receives an audio frame.
onFrame	Occurs when each time the player receives a video frame.