Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.rte.scene.AgoraRteScene Interface Reference

Public Member Functions

int join (String userId, String token, AgoraRteSceneJoinOptions joinOption)
 
void leave ()
 
AgoraRteSceneInfo getSceneInfo ()
 
AgoraRteUserInfo getLocalUserInfo ()
 
List< AgoraRteUserInfogetRemoteUsers ()
 
List< AgoraRteMediaStreamInfogetLocalStreams ()
 
List< AgoraRteMediaStreamInfogetRemoteStreams ()
 
List< AgoraRteMediaStreamInfogetRemoteStreamByUserId (String userId)
 
int createOrUpdateRTCStream (String streamId, AgoraRtcStreamOptions streamOption)
 
int createOrUpdateDirectCDNStream (String streamId, AgoraCdnStreamOptions streamOption)
 
int destroyStream (String streamId)
 
int setAudioEncoderConfiguration (String streamId, AgoraRteAudioEncoderConfiguration audioEncoderConfiguration)
 
int setVideoEncoderConfiguration (String streamId, AgoraRteVideoEncoderConfiguration videoEncoderConfiguration)
 
int setExtensionProperty (AgoraRteExtensionProperty extensionProperty)
 
AgoraRteExtensionProperty getExtensionProperty ()
 
int setCloudCDNTranscoding (String localStreamId, AgoraRteLiveTranscoding transcoding)
 
int addCloudCDNUrl (String localStreamId, String targetCdnUrl, boolean transcodingEnabled)
 
int removeCloudCDNUrl (String localStreamId, String targetCdnUrl)
 
int publishLocalAudioTrack (String streamId, AgoraRteAudioTrack audioTrack)
 
int publishLocalVideoTrack (String streamId, AgoraRteVideoTrack videoTrack)
 
int unpublishLocalAudioTrack (AgoraRteAudioTrack audioTrack)
 
int unpublishLocalVideoTrack (AgoraRteVideoTrack videoTrack)
 
int publishMediaPlayer (String streamId, AgoraRteMediaPlayer player)
 
int unpublishMediaPlayer (AgoraRteMediaPlayer player)
 
int subscribeRemoteAudio (String remoteStreamId)
 
int unsubscribeRemoteAudio (String remoteStreamId)
 
int subscribeRemoteVideo (String remoteStreamId, AgoraRteVideoSubscribeOptions videoSubscribeOption)
 
int unsubscribeRemoteVideo (String remoteStreamId)
 
int setRemoteVideoCanvas (String remoteStreamId, AgoraRteVideoCanvas canvas)
 
void registerSceneEventHandler (AgoraRteSceneEventHandler eventHandler)
 
void unregisterSceneEventHandler (AgoraRteSceneEventHandler eventHandler)
 
void registerRemoteVideoFrameObserver (AgoraRteVideoFrameObserver observer)
 
void unregisterRemoteVideoFrameObserver (AgoraRteVideoFrameObserver observer)
 
void registerAudioFrameObserver (AgoraRteAudioFrameObserver observer, AgoraRteAudioObserverOptions option)
 
void unregisterAudioFrameObserver (AgoraRteAudioFrameObserver observer)
 
int adjustUserPlaybackSignalVolume (String remoteStreamId, int volume)
 
int getUserPlaybackSignalVolume (String remoteStreamId)
 
void destroy ()
 
void setEventHandler (Handler eventHandler)
 

Member Function Documentation

◆ join()

int io.agora.rte.scene.AgoraRteScene.join ( String  userId,
String  token,
AgoraRteSceneJoinOptions  joinOption 
)

Joins an scene.

Parameters
userIdUser ID to join a scene.
tokenThe access token to join a scene.
joinOptionOptions to join a scene.
Returns
  • 0: success
  • < 0: failure

◆ leave()

void io.agora.rte.scene.AgoraRteScene.leave ( )

Leaves an scene.

◆ getSceneInfo()

AgoraRteSceneInfo io.agora.rte.scene.AgoraRteScene.getSceneInfo ( )

Get scene info.

Returns
Current scene info.

◆ getLocalUserInfo()

AgoraRteUserInfo io.agora.rte.scene.AgoraRteScene.getLocalUserInfo ( )

Gets information of the local user.

Returns
Information of the local user.

◆ getRemoteUsers()

List<AgoraRteUserInfo> io.agora.rte.scene.AgoraRteScene.getRemoteUsers ( )

Gets information of the local user.

Returns
Information of the local user.

◆ getLocalStreams()

List<AgoraRteMediaStreamInfo> io.agora.rte.scene.AgoraRteScene.getLocalStreams ( )

Gets the information of local streams.

Returns
Information of local streams.

◆ getRemoteStreams()

List<AgoraRteMediaStreamInfo> io.agora.rte.scene.AgoraRteScene.getRemoteStreams ( )

Gets the information of remote streams.

Returns
Information of remote streams.

◆ getRemoteStreamByUserId()

List<AgoraRteMediaStreamInfo> io.agora.rte.scene.AgoraRteScene.getRemoteStreamByUserId ( String  userId)

Gets the information of remote streams by user ID.

Parameters
userIdUser ID.
Returns
Information of remote streams.

◆ createOrUpdateRTCStream()

int io.agora.rte.scene.AgoraRteScene.createOrUpdateRTCStream ( String  streamId,
AgoraRtcStreamOptions  streamOption 
)

Create a Or Update RTC Stream object. If the stream doesn't exist, a new stream will be created, otherwise, the stream will be updated by the new option (e.g. rtc token will be updated).

Parameters
streamIdTarget stream id
streamOptionOptions to apply
Returns
  • 0: success
  • < 0: failure

◆ createOrUpdateDirectCDNStream()

int io.agora.rte.scene.AgoraRteScene.createOrUpdateDirectCDNStream ( String  streamId,
AgoraCdnStreamOptions  streamOption 
)

Create a Or Update CDN Stream object. If the stream doesn't exist, a new stream will be created, otherwise, the stream will be updated by the new option (e.g. CDN url will be updated).

Parameters
streamId
streamOption
Returns
  • 0: success
  • < 0: failure

◆ destroyStream()

int io.agora.rte.scene.AgoraRteScene.destroyStream ( String  streamId)

Destroys a local stream by ID.

Parameters
streamIdID of the local stream to be destroyed
Returns
  • 0: success
  • < 0: failure

◆ setAudioEncoderConfiguration()

int io.agora.rte.scene.AgoraRteScene.setAudioEncoderConfiguration ( String  streamId,
AgoraRteAudioEncoderConfiguration  audioEncoderConfiguration 
)

Configures the audio encoder for the local stream. Note that all audio tracks published to the stream will apply the new configuration.

Parameters
streamIdID of the local stream.
audioEncoderConfigurationAudio encoder configurations.
Returns
  • 0: success
  • < 0: failure

◆ setVideoEncoderConfiguration()

int io.agora.rte.scene.AgoraRteScene.setVideoEncoderConfiguration ( String  streamId,
AgoraRteVideoEncoderConfiguration  videoEncoderConfiguration 
)

Configures the video encoder for the local stream. Note that all video tracks published to the stream will apply the new configuration.

Parameters
streamIdID of the local stream.
videoEncoderConfigurationVideo encoder configurations.
Returns
  • 0: success
  • < 0: failure

◆ setExtensionProperty()

int io.agora.rte.scene.AgoraRteScene.setExtensionProperty ( AgoraRteExtensionProperty  extensionProperty)

Set extension specific property.

Parameters
extensionPropertythe extension property
Returns
  • 0: success
  • < 0: failure

◆ getExtensionProperty()

AgoraRteExtensionProperty io.agora.rte.scene.AgoraRteScene.getExtensionProperty ( )

Get extension specific property.

Returns
the extension property

◆ setCloudCDNTranscoding()

int io.agora.rte.scene.AgoraRteScene.setCloudCDNTranscoding ( String  localStreamId,
AgoraRteLiveTranscoding  transcoding 
)

Set the transcoding parameter for publish Cloud CDN If you call this method for the first time, it will NOT trigger the onBypassTranscodingUpdated callback,

Parameters
localStreamId
transcoding
Returns
  • 0: success
  • < 0: failure

◆ addCloudCDNUrl()

int io.agora.rte.scene.AgoraRteScene.addCloudCDNUrl ( String  localStreamId,
String  targetCdnUrl,
boolean  transcodingEnabled 
)

Add a target Cloud CDN URL to a local stream This method will trigger 'OnBypassCdnStateChanged' and 'onBypassCdnPublished' callback

Parameters
localStreamIdID of the local stream to be destroyed
targetCdnUrlThe CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special character, such as Chinese language characters.
transcodingEnabledSets whether transcoding is enabled/disabled. If you set this parameter as true, ensure that you call the setCloudCDNTranscoding method before this method.
Returns
  • 0: success
  • < 0: failure

◆ removeCloudCDNUrl()

int io.agora.rte.scene.AgoraRteScene.removeCloudCDNUrl ( String  localStreamId,
String  targetCdnUrl 
)

Remove a Cloud CDN URL from a local stream This method will trigger 'OnBypassCdnStateChanged' and 'onBypassCdnUnpublished' callback

Parameters
localStreamIdID of the local stream to be destroyed
targetCdnUrlThe CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special character, such as Chinese language characters.
Returns
  • 0: success
  • < 0: failure

◆ publishLocalAudioTrack()

int io.agora.rte.scene.AgoraRteScene.publishLocalAudioTrack ( String  streamId,
AgoraRteAudioTrack  audioTrack 
)

Publishes a local audio track to a local stream by ID. Note that remote peers could only see one audio track even several local audio tracks are published to the stream. This is because all local audio tracks will be mixed automatically in internal before sending the audio data to remote peers.

Parameters
streamIdID of the local stream.
audioTrackThe local audio track.
Returns
  • 0: success
  • < 0: failure

◆ publishLocalVideoTrack()

int io.agora.rte.scene.AgoraRteScene.publishLocalVideoTrack ( String  streamId,
AgoraRteVideoTrack  videoTrack 
)

Publishes a local video track to a local stream by ID. Note that one stream could only contains one video track, so several streams are required to publish several video tracks, or one stream with mixing all video tracks together.

Parameters
streamIdID of the local stream.
videoTrackThe local video track.
Returns
  • 0: success
  • < 0: failure

◆ unpublishLocalAudioTrack()

int io.agora.rte.scene.AgoraRteScene.unpublishLocalAudioTrack ( AgoraRteAudioTrack  audioTrack)

Unpublishes a local audio track.

Parameters
audioTrackThe local audio track.
Returns
  • 0: success
  • < 0: failure

◆ unpublishLocalVideoTrack()

int io.agora.rte.scene.AgoraRteScene.unpublishLocalVideoTrack ( AgoraRteVideoTrack  videoTrack)

Unpublishes a local video track. Note that even the track is unpublished, but for camera track or screen track, the track could be still captering data from camera or screen, so the preview function isn't impact after unpublishing. To stop the camera or screen track, user need to call stopCapture().

Parameters
videoTrackThe local video track.
Returns
  • 0: success
  • < 0: failure

◆ publishMediaPlayer()

int io.agora.rte.scene.AgoraRteScene.publishMediaPlayer ( String  streamId,
AgoraRteMediaPlayer  player 
)

Publishes a media player to a local stream by ID. The played audio and video will be sent to the stream.

Parameters
streamIdID of the local stream.
playerThe media player.
Returns
  • 0: success
  • < 0: failure

◆ unpublishMediaPlayer()

int io.agora.rte.scene.AgoraRteScene.unpublishMediaPlayer ( AgoraRteMediaPlayer  player)

Unpublishes a media player.

Parameters
playerThe media player.
Returns
  • 0: success
  • < 0: failure

◆ subscribeRemoteAudio()

int io.agora.rte.scene.AgoraRteScene.subscribeRemoteAudio ( String  remoteStreamId)

Subscribes the remote audio data from remote stream

Parameters
remoteStreamIdThe remote stream ID.
Returns
  • 0: success
  • < 0: failure

◆ unsubscribeRemoteAudio()

int io.agora.rte.scene.AgoraRteScene.unsubscribeRemoteAudio ( String  remoteStreamId)

Unsubscribes the remote audio data from remote stream

Parameters
remoteStreamIdThe remote stream ID.
Returns
  • 0: success
  • < 0: failure

◆ subscribeRemoteVideo()

int io.agora.rte.scene.AgoraRteScene.subscribeRemoteVideo ( String  remoteStreamId,
AgoraRteVideoSubscribeOptions  videoSubscribeOption 
)

Subscribes the remote video data from remote stream

Parameters
remoteStreamIdThe remote stream ID.
videoSubscribeOptionSubscription options.
Returns
  • 0: success
  • < 0: failure

◆ unsubscribeRemoteVideo()

int io.agora.rte.scene.AgoraRteScene.unsubscribeRemoteVideo ( String  remoteStreamId)

Unsubscribes the remote video data from remote stream

Parameters
remoteStreamIdThe remote stream ID.
Returns
  • 0: success
  • < 0: failure

◆ setRemoteVideoCanvas()

int io.agora.rte.scene.AgoraRteScene.setRemoteVideoCanvas ( String  remoteStreamId,
AgoraRteVideoCanvas  canvas 
)

Set video canvas for the remote stream. Video frame from the remote stream will be applied to the canvas. Note that SDK will try to hold related resource internal (e.g window resource from system), and the resource referenced by canvas will be released when scene is destroyed or user set the canvas with empty resource.

Parameters
remoteStreamIdThe remote stream ID
canvasThe input Canvas.
Returns
  • 0: success
  • < 0: failure

◆ registerSceneEventHandler()

void io.agora.rte.scene.AgoraRteScene.registerSceneEventHandler ( AgoraRteSceneEventHandler  eventHandler)

Registers an event handler for the scene.

Parameters
eventHandlerAn IAgoraRteSceneEventHandler object.

◆ unregisterSceneEventHandler()

void io.agora.rte.scene.AgoraRteScene.unregisterSceneEventHandler ( AgoraRteSceneEventHandler  eventHandler)

Unregisters an event handler.

Parameters
eventHandlerAn IAgoraRteSceneEventHandler object.

◆ registerRemoteVideoFrameObserver()

void io.agora.rte.scene.AgoraRteScene.registerRemoteVideoFrameObserver ( AgoraRteVideoFrameObserver  observer)

Registers a video frame observer for the remote stream. For local video frame observer, user can register observer on track object.

Parameters
observerAn IAgoraRteVideoFrameObserver object.

◆ unregisterRemoteVideoFrameObserver()

void io.agora.rte.scene.AgoraRteScene.unregisterRemoteVideoFrameObserver ( AgoraRteVideoFrameObserver  observer)

Unregisters an audio frame observer.

Parameters
observerAn IAgoraRteVideoFrameObserver object.

◆ registerAudioFrameObserver()

void io.agora.rte.scene.AgoraRteScene.registerAudioFrameObserver ( AgoraRteAudioFrameObserver  observer,
AgoraRteAudioObserverOptions  option 
)

Registers a audio frame observer for the local or remote stream.

Parameters
observerAn IAgoraRteAudioFrameObserver object.
optionAudio observer option

◆ unregisterAudioFrameObserver()

void io.agora.rte.scene.AgoraRteScene.unregisterAudioFrameObserver ( AgoraRteAudioFrameObserver  observer)

Unregisters an audio frame observer.

Parameters
observerAn IAgoraRteAudioFrameObserver object.

◆ adjustUserPlaybackSignalVolume()

int io.agora.rte.scene.AgoraRteScene.adjustUserPlaybackSignalVolume ( String  remoteStreamId,
int  volume 
)

Adjust the playback volume for remote user

Parameters
remoteStreamIdThe remote stream id
volumeThe playback volume, range is [0,100]
Returns
  • 0: success
  • < 0: failure

◆ getUserPlaybackSignalVolume()

int io.agora.rte.scene.AgoraRteScene.getUserPlaybackSignalVolume ( String  remoteStreamId)

Get the playback volume for remote user

Parameters
remoteStreamIdThe remote stream id
Returns
  • >= 0: The playback volume
  • < 0: failure

◆ destroy()

void io.agora.rte.scene.AgoraRteScene.destroy ( )

destroy agora scene

◆ setEventHandler()

void io.agora.rte.scene.AgoraRteScene.setEventHandler ( Handler  eventHandler)

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

Parameters
eventHandlerandroid handler