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

Public Member Functions

AgoraRtePlayList createPlayList ()
 
AgoraRteVideoTrack getRteVideoTrack ()
 
AgoraRteAudioTrack getRteAudioTrack ()
 
int open (String url, long startPos, boolean autoPlay)
 
int open (AgoraRtePlayList playList, long startPos, boolean autoPlay)
 
int close ()
 
boolean isVideoValid ()
 
boolean isAudioValid ()
 
long getDuration ()
 
long getStreamCount ()
 
AgoraRtePlayerStreamInfo getStreamInfo (long index)
 
int setLoopCount (long loopCount)
 
int play ()
 
int pause ()
 
int stop ()
 
int seek (long newPos)
 
int seekToPrev (long pos)
 
int seekToNext (long pos)
 
int seekToFile (int fileId, long pos)
 
AgoraRteStreamingSourceStatus getStreamingSourceStatus ()
 
long getCurrPosition ()
 
AgoraRteStreamingSrcState getCurrState ()
 
int appendSeiData (AgoraRteInputSeiData seiData)
 
int registerObserver (AgoraRteStreamingSourceObserver observer)
 
int unregisterObserver (AgoraRteStreamingSourceObserver observer)
 
void destroy ()
 
void setEventHandler (Handler eventHandler)
 

Member Function Documentation

◆ createPlayList()

AgoraRtePlayList io.agora.rte.media.stream.AgoraRteStreamingSource.createPlayList ( )

Create the play list

Returns
play list

◆ getRteVideoTrack()

AgoraRteVideoTrack io.agora.rte.media.stream.AgoraRteStreamingSource.getRteVideoTrack ( )

Retrieve the RTE video track

Returns
video track

◆ getRteAudioTrack()

AgoraRteAudioTrack io.agora.rte.media.stream.AgoraRteStreamingSource.getRteAudioTrack ( )

Retrieve the RTE audio track

Returns
audio track

◆ open() [1/2]

int io.agora.rte.media.stream.AgoraRteStreamingSource.open ( String  url,
long  startPos,
boolean  autoPlay 
)

Opens a media streaming source with a specified URL.

Parameters
urlThe path of the media file. Both the local path and online path are supported.
startPosThe starting position (ms) for pushing. Default value is 0.
autoPlaywhether start playing after opened
Returns
  • 0: success
  • < 0: failure

◆ open() [2/2]

int io.agora.rte.media.stream.AgoraRteStreamingSource.open ( AgoraRtePlayList  playList,
long  startPos,
boolean  autoPlay 
)

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.
autoPlaywhether start playing after opened
Returns
  • 0: success
  • < 0: failure

◆ close()

int io.agora.rte.media.stream.AgoraRteStreamingSource.close ( )

Close current media streaming source

Returns
  • 0: success
  • < 0: failure

◆ isVideoValid()

boolean io.agora.rte.media.stream.AgoraRteStreamingSource.isVideoValid ( )

Retrieve whether video stream is valid

Returns
valid or invalid

◆ isAudioValid()

boolean io.agora.rte.media.stream.AgoraRteStreamingSource.isAudioValid ( )

Retrieve whether audio stream is valid

Returns
valid or invalid

◆ getDuration()

long io.agora.rte.media.stream.AgoraRteStreamingSource.getDuration ( )

Gets the duration of the streaming source.

Returns
the duration of the media file.

◆ getStreamCount()

long io.agora.rte.media.stream.AgoraRteStreamingSource.getStreamCount ( )

Gets the number of the streming source

Returns
The number of the media streams in the media source.

◆ getStreamInfo()

AgoraRtePlayerStreamInfo io.agora.rte.media.stream.AgoraRteStreamingSource.getStreamInfo ( long  index)

Gets the detailed information of a media stream.

Parameters
indexThe index of the media stream.
Returns
  • 0: success
  • < 0: failure

◆ setLoopCount()

int io.agora.rte.media.stream.AgoraRteStreamingSource.setLoopCount ( long  loopCount)

Sets whether to loop the streaming source for playback.

Parameters
loopCountThe number of times of looping the media file.
Returns
  • 0: success
  • < 0: failure

◆ play()

int io.agora.rte.media.stream.AgoraRteStreamingSource.play ( )

Play & push the streaming source.

Returns
  • 0: success
  • < 0: failure

◆ pause()

int io.agora.rte.media.stream.AgoraRteStreamingSource.pause ( )

Pauses the playing & pushing of the streaming source, Keep current position.

Returns
  • 0: success
  • < 0: failure

◆ stop()

int io.agora.rte.media.stream.AgoraRteStreamingSource.stop ( )

Stop the playing & pushing of the streaming source, set the position to 0.

Returns
  • 0: success
  • < 0: failure

◆ seek()

int io.agora.rte.media.stream.AgoraRteStreamingSource.seek ( long  newPos)

Sets the playback positionin current file After seek done, it will return to previous status

Parameters
newPosThe new playback position (ms).
Returns
  • 0: success
  • < 0: failure

◆ seekToPrev()

int io.agora.rte.media.stream.AgoraRteStreamingSource.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.stream.AgoraRteStreamingSource.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.stream.AgoraRteStreamingSource.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

◆ getStreamingSourceStatus()

AgoraRteStreamingSourceStatus io.agora.rte.media.stream.AgoraRteStreamingSource.getStreamingSourceStatus ( )

Get the stream source status

Returns
stream source status

◆ getCurrPosition()

long io.agora.rte.media.stream.AgoraRteStreamingSource.getCurrPosition ( )

Gets the current playback position of the media file.

Returns
the current playback position (ms).

◆ getCurrState()

AgoraRteStreamingSrcState io.agora.rte.media.stream.AgoraRteStreamingSource.getCurrState ( )

Gets the status of current streaming source.

Returns
The current state machine

◆ appendSeiData()

int io.agora.rte.media.stream.AgoraRteStreamingSource.appendSeiData ( AgoraRteInputSeiData  seiData)

Appends the SEI data, which can be attached to video packet

Parameters
seiDatathe SEI data
Returns
  • 0: success
  • < 0: failure

◆ registerObserver()

int io.agora.rte.media.stream.AgoraRteStreamingSource.registerObserver ( AgoraRteStreamingSourceObserver  observer)

Registers a media player source observer. Once the media player source observer is registered, you can use the observer to monitor the state change of the media player.

Parameters
observerStreamingSourceObserver
Returns
  • 0: success
  • < 0: failure

◆ unregisterObserver()

int io.agora.rte.media.stream.AgoraRteStreamingSource.unregisterObserver ( AgoraRteStreamingSourceObserver  observer)

Unregisters the media player source observer.

Parameters
observerStreamingSourceObserver
Returns
  • 0: success
  • < 0: failure

◆ destroy()

void io.agora.rte.media.stream.AgoraRteStreamingSource.destroy ( )

destroy streaming source

◆ setEventHandler()

void io.agora.rte.media.stream.AgoraRteStreamingSource.setEventHandler ( Handler  eventHandler)

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

Parameters
eventHandlerandroid handler