Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.rte.media.media_player.AgoraRteMediaPlayer Interface Reference

Public Member Functions

AgoraRtePlayList createPlayList ()
 
int open (String url, long startPos)
 
int open (AgoraRtePlayList playList, long startPos)
 
int play ()
 
int pause ()
 
int resume ()
 
int stop ()
 
int seek (long pos)
 
int seekToPrev (long pos)
 
int seekToNext (long pos)
 
int seekToFile (int fileId, long pos)
 
int changePlaybackSpeed (AgoraRteMediaPlayerPlaybackSpeed playbackSpeed)
 
int adjustPlayoutVolume (int volume)
 
int mute (boolean mute)
 
int selectAudioTrack (int index)
 
int setLoopCount (int loopCount)
 
int muteAudio (boolean audioMute)
 
boolean isAudioMuted ()
 
int muteVideo (boolean videoMute)
 
boolean isVideoMuted ()
 
int setView (View view)
 
int setRenderMode (AgoraRteRenderMode mode)
 
int setPlayerOption (String key, int value)
 
int setPlayerOptionString (String key, String value)
 
AgoraRtePlayerStatus getPlayerStatus ()
 
AgoraRteMediaPlayerState getState ()
 
long getDuration ()
 
long getPlayPosition ()
 
int getPlayoutVolume ()
 
long getStreamCount ()
 
AgoraRtePlayerStreamInfo getStreamInfo (long index)
 
boolean isMuted ()
 
String getPlayerVersion ()
 
int setStreamId (String streamId)
 
String getStreamId ()
 
int registerMediaPlayerObserver (AgoraRteMediaPlayerObserver observer)
 
int unregisterMediaPlayerObserver (AgoraRteMediaPlayerObserver observer)
 
AgoraRteVideoTrack getVideoTrack ()
 
AgoraRteAudioTrack getAudioTrack ()
 
void destroy ()
 
void setEventHandler (Handler eventHandler)
 

Member Function Documentation

◆ createPlayList()

AgoraRtePlayList io.agora.rte.media.media_player.AgoraRteMediaPlayer.createPlayList ( )

Creates a play list.

Returns
the new IAgoraRtePlayList object

◆ open() [1/2]

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.open ( String  url,
long  startPos 
)

open a media file with URL and start position

Parameters
urlurl The URL of the file to be opened.
startPosstart_pos The start position of the file to be opened.
Returns
  • 0: success
  • < 0: failure

◆ open() [2/2]

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.open ( AgoraRtePlayList  playList,
long  startPos 
)

Open a play list with start position of first file.

Parameters
playListThe play list which will be played
startPosThe start position of the file to be opened.
Returns
  • 0: success
  • < 0: failure

◆ play()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.play ( )

play the media file

Returns
  • 0: success
  • < 0: failure

◆ pause()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.pause ( )

pause the playing media file

Returns
  • 0: success
  • < 0: failure

◆ resume()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.resume ( )

resume the paused media file

Returns
  • 0: success
  • < 0: failure

◆ stop()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.stop ( )

stop the playing media file

Returns
  • 0: success
  • < 0: failure

◆ seek()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.seek ( long  pos)

Seek the playing media file to a position in current file

Parameters
posThe position in current file to be seeked.
Returns
  • 0: success
  • < 0: failure

◆ seekToPrev()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.seekToPrev ( long  pos)

Seek the playing media file to previous file with a start position

Parameters
posThe position to be seeked in the file.
Returns
  • 0: success
  • < 0: failure

◆ seekToNext()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.seekToNext ( long  pos)

Seek the playing media file to next file with a start position

Parameters
posThe position to be seeked in the file.
Returns
  • 0: success
  • < 0: failure

◆ seekToFile()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.seekToFile ( int  fileId,
long  pos 
)

Seek the playing media file to appointed file with a start position directly

Parameters
fileIdThe file id that should be seeked
posThe position to be seeked in the file.
Returns
  • 0: success
  • < 0: failure

◆ changePlaybackSpeed()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.changePlaybackSpeed ( AgoraRteMediaPlayerPlaybackSpeed  playbackSpeed)

Change playback speed.

Returns

◆ adjustPlayoutVolume()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.adjustPlayoutVolume ( int  volume)

Adjust playout volume.

Parameters
volumeThe volume to be adjusted to.
Returns
  • 0: success
  • < 0: failure

◆ mute()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.mute ( boolean  mute)

Mute/unmute the playing.

Parameters
muteWhether mute or unmute the playing.
Returns
  • 0: success
  • < 0: failure

◆ selectAudioTrack()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.selectAudioTrack ( int  index)

Select audio track.

Parameters
indexThe index of the to be selected audio track.
Returns
  • 0: success
  • < 0: failure

◆ setLoopCount()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setLoopCount ( int  loopCount)

Mute the audio playing

Parameters
loopCountloop count
Returns
  • 0: success
  • < 0: failure

◆ muteAudio()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.muteAudio ( boolean  audioMute)

Mute the audio playing

Parameters
audioMutemute or unmute audio
Returns
  • 0: success
  • < 0: failure

◆ isAudioMuted()

boolean io.agora.rte.media.media_player.AgoraRteMediaPlayer.isAudioMuted ( )

Gets whehter audio is muted

Returns
: true or false

◆ muteVideo()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.muteVideo ( boolean  videoMute)

Mute the video playing

Parameters
videoMutemute or unmute video
Returns
  • 0: success
  • < 0: failure

◆ isVideoMuted()

boolean io.agora.rte.media.media_player.AgoraRteMediaPlayer.isVideoMuted ( )

Gets whehter video is muted

Returns
: true or false

◆ setView()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setView ( View  view)

Set view.

Parameters
viewThe view pointer to be set.
Returns
  • 0: success
  • < 0: failure

◆ setRenderMode()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setRenderMode ( AgoraRteRenderMode  mode)

Set render mode.

Parameters
modeThe render mode to be set.
Returns
  • 0: success
  • < 0: failure

◆ setPlayerOption()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setPlayerOption ( String  key,
int  value 
)

Set player option with an integer value.

Parameters
keyThe key of the option to be set.
valueThe value of the option to be set.
Returns
  • 0: success
  • < 0: failure

◆ setPlayerOptionString()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setPlayerOptionString ( String  key,
String  value 
)

Set player option with a string value.

Parameters
keyThe key of the option to be set.
valueThe value of the option to be set.
Returns
  • 0: success
  • < 0: failure

◆ getPlayerStatus()

AgoraRtePlayerStatus io.agora.rte.media.media_player.AgoraRteMediaPlayer.getPlayerStatus ( )

Get current playing status of Media Player .

Returns
player status

◆ getState()

AgoraRteMediaPlayerState io.agora.rte.media.media_player.AgoraRteMediaPlayer.getState ( )

Get player state.

Returns
Current player state.

◆ getDuration()

long io.agora.rte.media.media_player.AgoraRteMediaPlayer.getDuration ( )

Get duration.

Returns
duration

◆ getPlayPosition()

long io.agora.rte.media.media_player.AgoraRteMediaPlayer.getPlayPosition ( )

Get play position.

Returns
current play position

◆ getPlayoutVolume()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.getPlayoutVolume ( )

Get play volume.

Returns
play volume

◆ getStreamCount()

long io.agora.rte.media.media_player.AgoraRteMediaPlayer.getStreamCount ( )

Get stream count.

Returns
stream count

◆ getStreamInfo()

AgoraRtePlayerStreamInfo io.agora.rte.media.media_player.AgoraRteMediaPlayer.getStreamInfo ( long  index)

Get stream info.

Parameters
indexThe index of the stream info.
Returns
current stream info

◆ isMuted()

boolean io.agora.rte.media.media_player.AgoraRteMediaPlayer.isMuted ( )

Get whether muted.

Returns
Whether muted.

◆ getPlayerVersion()

String io.agora.rte.media.media_player.AgoraRteMediaPlayer.getPlayerVersion ( )

Get player version.

Returns
Current player version.

◆ setStreamId()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.setStreamId ( String  streamId)

Set stream ID.

Parameters
streamIdThe stream ID to be set.
Returns
  • 0: success
  • < 0: failure

◆ getStreamId()

String io.agora.rte.media.media_player.AgoraRteMediaPlayer.getStreamId ( )

Get stream ID.

Returns
stream id

◆ registerMediaPlayerObserver()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.registerMediaPlayerObserver ( AgoraRteMediaPlayerObserver  observer)

Register media player observer.

Parameters
observerThe observer to be registered.
Returns
  • 0: success
  • < 0: failure

◆ unregisterMediaPlayerObserver()

int io.agora.rte.media.media_player.AgoraRteMediaPlayer.unregisterMediaPlayerObserver ( AgoraRteMediaPlayerObserver  observer)

Unregister media player observer.

Parameters
observerThe observer to be unregistered.
Returns
  • 0: success
  • < 0: failure

◆ getVideoTrack()

AgoraRteVideoTrack io.agora.rte.media.media_player.AgoraRteMediaPlayer.getVideoTrack ( )

Get video track

Returns
video track

◆ getAudioTrack()

AgoraRteAudioTrack io.agora.rte.media.media_player.AgoraRteMediaPlayer.getAudioTrack ( )

Get audio track

Returns
audio track

◆ destroy()

void io.agora.rte.media.media_player.AgoraRteMediaPlayer.destroy ( )

destroy media player

◆ setEventHandler()

void io.agora.rte.media.media_player.AgoraRteMediaPlayer.setEventHandler ( Handler  eventHandler)

set event handler, and event callback thrown from MainLooper by default

Parameters
eventHandlerandroid handler