Android SDK API Reference

setMediaRecorderObserver(callback: IMediaRecorderCallback): int
startRecording(config: MediaRecorderConfiguration): int
stopRecording(): int

onResult(error: Error): void

Canvas(rte: Rte, config: CanvasInitialConfig): unknown
addView(view: View, viewConfig: ViewConfig): void
getConfigs(config: CanvasConfig): void
removeView(view: View, viewConfig: ViewConfig): void
setConfigs(config: CanvasConfig): void

getVideoMirrorMode(): Constants.VideoMirrorMode
getVideoRenderMode(): Constants.VideoRenderMode
setVideoMirrorMode(mode: Constants.VideoMirrorMode): void
setVideoRenderMode(mode: Constants.VideoRenderMode): void

removeDestChannelInfo(channelName: String): void
setDestChannelInfo(channelName: String, destInfo: ChannelMediaInfo): void
setSrcChannelInfo(srcInfo: ChannelMediaInfo): void

getAppId(): String
getJsonParameter(): String
setAppId(appId: String): void
setJsonParameter(jsonParameter: String): void

code(): Constants.ErrorCode
message(): String

createMusicPlayer(): IAgoraMusicPlayer
destroy(): void
destroyMusicPlayer(player: IAgoraMusicPlayer): int
getCaches(): MusicCacheInfo[]
getInternalSongCode(songCode: long, jsonOption: String): long
getLyric(songCode: long, lyricType: int): String
getMusicCharts(): String
getMusicCollectionByMusicChartId(musicChartId: int, page: int, pageSize: int): String
getMusicCollectionByMusicChartId(musicChartId: int, page: int, pageSize: int, jsonOption: String): String
getSongSimpleInfo(songCode: long): String
initialize(configuration: MusicContentCenterConfiguration): int
isPreloaded(songCode: long): int
preload(songCode: long, jsonOption: String): int
preload(songCode: long): String
registerEventHandler(eventHandler: IMusicContentCenterEventHandler): int
removeCache(songCode: long): int
renewToken(token: String): int
searchMusic(keyword: String, page: int, pageSize: int): String
searchMusic(keyword: String, page: int, pageSize: int, jsonOption: String): String
unregisterEventHandler(): int

destroy(): int
getPlaySrc(): String
open(songCode: long, startPos: long): int
open(url: String, startPos: long): int
setPlayMode(mode: MusicPlayMode): int
stop(): int

onMixedAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void
onPlaybackAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void
onRecordAudioEncodedFrame(buffer: ByteBuffer, samplesPerChannel: int, channels: int, samplesPerSec: int, codecType: int): void

getEarMonitoringAudioParams(): AudioParams
getMixedAudioParams(): AudioParams
getObservedAudioFramePosition(): int
getPlaybackAudioParams(): AudioParams
getRecordAudioParams(): AudioParams
onEarMonitoringAudioFrame(type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onMixedAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onPlaybackAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean
onPlaybackAudioFrameBeforeMixing(channelId: String, uid: int, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int, rtpTimestamp: int, presentationMs: long): boolean
onRecordAudioFrame(channelId: String, type: int, samplesPerChannel: int, bytesPerSample: int, channels: int, samplesPerSec: int, buffer: ByteBuffer, renderTimeMs: long, avsync_type: int): boolean

onLocalAudioSpectrum(data: AudioSpectrumInfo): boolean
onRemoteAudioSpectrum(userAudioSpectrumInfos: UserAudioSpectrumInfo[], spectrumNumber: int): boolean

clearRemotePositions(): int
muteAllRemoteAudioStreams(mute: boolean): int
muteLocalAudioStream(mute: boolean): int
muteRemoteAudioStream(uid: int, mute: boolean): int
setAudioRecvRange(range: float): int
setDistanceUnit(unit: float): int
setMaxAudioRecvCount(maxCount: int): int
setPlayerAttenuation(playerId: int, attenuation: double, forceSet: boolean): int
setZones(zones: SpatialAudioZone[]): int
updatePlayerPositionInfo(playerId: int, positionInfo: RemoteVoicePositionInfo): int
updateSelfPosition(position: float[], axisForward: float[], axisRight: float[], axisUp: float[]): int

create(): ILocalSpatialAudioEngine
destroy(): void
initialize(config: LocalSpatialAudioConfig): int
removeRemotePosition(uid: int): int
setRemoteAudioAttenuation(uid: int, attenuation: double, forceSet: boolean): int
updateRemotePosition(uid: int, posInfo: RemoteVoicePositionInfo): int

adjustPlayoutVolume(volume: int): int
adjustPublishSignalVolume(volume: int): int
destroy(): int
getAudioBufferDelay(): int
getDuration(): long
getMediaPlayerId(): int
getMute(): boolean
getPlayPosition(): long
getPlaySrc(): String
getPlayoutVolume(): int
getPublishSignalVolume(): int
getState(): Constants.MediaPlayerState
getStreamCount(): int
getStreamInfo(index: int): MediaStreamInfo
mute(muted: boolean): int
open(url: String, startPos: long): int
open(uri: Uri, startPos: long): int
openWithMediaSource(source: MediaPlayerSource): int
pause(): int
play(): int
playPreloadedSrc(src: String): int
preloadSrc(src: String, startPos: long): int
registerAudioFrameObserver(audioFrameObserver: IMediaPlayerAudioFrameObserver, mode: int): int
registerPlayerObserver(playerObserver: IMediaPlayerObserver): int
registerVideoFrameObserver(videoFrameObserver: IMediaPlayerVideoFrameObserver): int
resume(): int
seek(newPos: long): int
selectAudioTrack(index: int): int
selectMultiAudioTrack(playoutTrackIndex: int, publishTrackIndex: int): int
setAudioDualMonoMode(mode: int): int
setAudioPitch(pitch: int): int
setLoopCount(loopCount: int): int
setPlaybackSpeed(speed: int): int
setPlayerOption(key: String, value: int): int
setPlayerOptionString(key: String, value: String): int
setSpatialAudioParams(params: SpatialAudioParams): int
setVideoRenderMode(mode: unknown): unknown
setView(videoView: View): int
stop(): int
switchSrc(src: String, syncPts: boolean): int
unRegisterPlayerObserver(playerObserver: IMediaPlayerObserver): int
unloadSrc(src: String): int

onFrame(frame: AudioFrame): AudioFrame

enableAutoRemoveCache(enable: boolean): int
getCacheDir(): String
getCacheFileCount(): int
getMaxCacheFileCount(): int
getMaxCacheFileSize(): long
getMediaPlayerCacheManager(): IMediaPlayerCacheManager
removeAllCaches(): int
removeCacheByUri(uri: String): int
removeOldCache(): int
setCacheDir(path: String): int
setMaxCacheFileCount(count: int): int
setMaxCacheFileSize(cacheSize: long): int

onReadData(buffer: ByteBuffer, bufferSize: int): int
onSeek(offset: long, whence: int): long

onAudioVolumeIndication(volume: int): void
onMetaData(type: Constants.MediaPlayerMetadataType, data: byte[]): void
onPlayBufferUpdated(playCachedBuffer: long): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: Constants.MediaPlayerEvent, elapsedTime: long, message: String): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPlayerStateChanged(state: Constants.MediaPlayerState, reason: Constants.MediaPlayerReason): void
onPositionChanged(positionMs: long, timestampMs: long): void
onPreloadEvent(src: String, event: Constants.MediaPlayerPreloadEvent): void

onFrame(frame: VideoFrame): void

onRecorderInfoUpdated(channelId: String, uid: int, info: RecorderInfo): void
onRecorderStateChanged(channelId: String, uid: int, state: int, reason: int): void

getMaxMetadataSize(): int
onMetadataReceived(metadata: AgoraMetadata): void
onReadyToSendMetadata(timeStampMs: long, sourceType: int): byte[]

onLyricResult(requestId: String, songCode: long, lyricUrl: String, reason: int): void
onMusicChartsResult(requestId: String, list: MusicChartInfo[], reason: int): void
onMusicCollectionResult(requestId: String, page: int, pageSize: int, total: int, list: Music[], reason: int): void
onPreLoadEvent(requestId: String, songCode: long, percent: int, lyricUrl: String, state: int, reason: int): void
onSongSimpleInfoResult(requestId: String, songCode: long, simpleInfo: String, reason: int): void

onActiveSpeaker(uid: int): void
onAudioEffectFinished(soundId: int): void
onAudioMixingFinished(): void
onAudioMixingPositionChanged(position: long): void
onAudioMixingStateChanged(state: int, reason: int): void
onAudioPublishStateChanged(channel: String, oldState: int, newState: int, elapseSinceLastState: int): void
onAudioQuality(uid: int, quality: int, delay: short, lost: short): void
onAudioRouteChanged(routing: int): void
onAudioSubscribeStateChanged(channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int): void
onAudioVolumeIndication(speakers: AudioVolumeInfo[], totalVolume: int): void
onCameraExposureAreaChanged(rect: Rect): void
onCameraFocusAreaChanged(rect: Rect): void
onCameraReady(): void
onChannelMediaRelayStateChanged(state: int, code: int): void
onClientRoleChangeFailed(reason: int, currentRole: int): void
onClientRoleChanged(oldRole: int, newRole: int, newRoleOptions: ClientRoleOptions): void
onConnectionBanned(): void
onConnectionInterrupted(): void
onConnectionLost(): void
onConnectionStateChanged(state: int, reason: int): void
onEncryptionError(errorType: int): void
onError(err: int): void
onErrorWithContext(extContext: ExtensionContext, error: int, message: String): void
onEventWithContext(extContext: ExtensionContext, key: String, value: String): void
onFacePositionChanged(imageWidth: int, imageHeight: int, faceRectArr: AgoraFacePositionInfo[]): void
onFirstLocalAudioFramePublished(elapsed: int): void
onFirstLocalVideoFrame(source: Constants.VideoSourceType, width: int, height: int, elapsed: int): void
onFirstLocalVideoFramePublished(source: Constants.VideoSourceType, elapsed: int): void
onFirstRemoteAudioDecoded(uid: int, elapsed: int): void
onFirstRemoteAudioFrame(uid: int, elapsed: int): void
onFirstRemoteVideoDecoded(uid: int, width: int, height: int, elapsed: int): void
onFirstRemoteVideoFrame(uid: int, width: int, height: int, elapsed: int): void
onJoinChannelSuccess(channel: String, uid: int, elapsed: int): void
onLastmileProbeResult(result: LastmileProbeResult): void
onLastmileQuality(quality: int): void
onLeaveChannel(stats: RtcStats): void
onLocalAudioStateChanged(state: int, reason: int): void
onLocalAudioStats(stats: LocalAudioStats): void
onLocalUserRegistered(uid: int, userAccount: String): void
onLocalVideoEvent(source: Constants.VideoSourceType, event: int): void
onLocalVideoStateChanged(source: Constants.VideoSourceType, state: int, reason: int): void
onLocalVideoStats(source: Constants.VideoSourceType, stats: LocalVideoStats): void
onLocalVideoTranscoderError(stream: LocalTranscoderConfiguration.TranscodingVideoStream, error: int): void
onMultipathStats(stats: MultipathStats): void
onNetworkQuality(uid: int, txQuality: int, rxQuality: int): void
onNetworkTypeChanged(type: int): void
onPermissionError(permission: int): void
onPermissionGranted(permission: int): void
onProxyConnected(channel: String, uid: int, proxyType: int, localProxyIp: String, elapsed: int): void
onRejoinChannelSuccess(channel: String, uid: int, elapsed: int): void
onRemoteAudioStateChanged(uid: int, state: int, reason: int, elapsed: int): void
onRemoteAudioStats(stats: RemoteAudioStats): void
onRemoteAudioTransportStats(uid: int, delay: int, lost: int, rxKBitRate: int): void
onRemoteSubscribeFallbackToAudioOnly(uid: int, isFallbackOrRecover: boolean): void
onRemoteVideoStateChanged(uid: int, state: int, reason: int, elapsed: int): void
onRemoteVideoStats(stats: RemoteVideoStats): void
onRemoteVideoTransportStats(uid: int, delay: int, lost: int, rxKBitRate: int): void
onRenewTokenResult(token: String, code: Constants.RenewTokenErrorCode): void
onRequestToken(): void
onRhythmPlayerStateChanged(state: int, reason: int): void
onRtcStats(stats: RtcStats): void
onRtmpStreamingEvent(url: String, event: int): void
onRtmpStreamingStateChanged(url: String, state: int, reason: int): void
onSnapshotTaken(uid: int, filePath: String, width: int, height: int, errCode: int): void
onStartedWithContext(extContext: ExtensionContext): void
onStoppedWithContext(extContext: ExtensionContext): void
onStreamMessage(uid: int, streamId: int, data: byte[]): void
onStreamMessageError(uid: int, streamId: int, error: int, missed: int, cached: int): void
onTokenPrivilegeWillExpire(token: String): void
onTranscodedStreamLayoutInfo(uid: int, info: VideoLayoutInfo): void
onTranscodingUpdated(): void
onUplinkNetworkInfoUpdated(info: UplinkNetworkInfo): void
onUserEnableLocalVideo(uid: int, enabled: boolean): void
onUserEnableVideo(uid: int, enabled: boolean): void
onUserInfoUpdated(uid: int, userInfo: UserInfo): void
onUserJoined(uid: int, elapsed: int): void
onUserMuteAudio(uid: int, muted: boolean): void
onUserMuteVideo(uid: int, muted: boolean): void
onUserOffline(uid: int, reason: int): void
onVideoPublishStateChanged(source: Constants.VideoSourceType, channel: String, oldState: int, newState: int, elapseSinceLastState: int): void
onVideoRenderingTracingResult(uid: int, currentEvent: Constants.MEDIA_TRACE_EVENT, tracingInfo: VideoRenderingTracingInfo): void
onVideoSizeChanged(source: Constants.VideoSourceType, uid: int, width: int, height: int, rotation: int): void
onVideoStopped(): void
onVideoSubscribeStateChanged(channel: String, uid: int, oldState: int, newState: int, elapseSinceLastState: int): void

onEngineReleased(): void

addOrUpdateVideoEffect(nodeId: int, templateName: String): int
getVideoEffectBoolParam(option: String, key: String): boolean
getVideoEffectFloatParam(option: String, key: String): float
getVideoEffectIntParam(option: String, key: String): int
performVideoEffectAction(nodeId: int, actionId: VIDEO_EFFECT_ACTION): int
removeVideoEffect(nodeId: int): int
setVideoEffectBoolParam(option: String, key: String, value: boolean): int
setVideoEffectFloatParam(option: String, key: String, value: float): int
setVideoEffectIntParam(option: String, key: String, value: int): int
setVideoEffectStringParam(option: String, key: String, value: String): int

onEncodedVideoFrameReceived(channelId: String, remoteUid: int, buffer: ByteBuffer, info: EncodedVideoFrameInfo): boolean

getMirrorApplied(): boolean
getObservedFramePosition(): int
getRotationApplied(): boolean
getVideoFormatPreference(): int
getVideoFrameProcessMode(): int
onCaptureVideoFrame(sourceType: int, videoFrame: VideoFrame): boolean
onPreEncodeVideoFrame(sourceType: int, videoFrame: VideoFrame): boolean
onRenderVideoFrame(channelId: String, uid: int, videoFrame: VideoFrame): boolean

addBackgroundImage(backgroundImage: AgoraImage): void
addUser(user: TranscodingUser): int
addWatermark(watermark: AgoraImage): void
getAdvancedFeatures(): Map
getBackgroundColor(): int
getBackgroundImageList(): ArrayList
getBlue(): int
getGreen(): int
getRed(): int
getUserCount(): int
getUsers(): ArrayList
getWatermarkList(): ArrayList
removeBackgroundImage(backgroundImage: AgoraImage): boolean
removeUser(uid: int): int
removeWatermark(watermark: AgoraImage): boolean
setAdvancedFeatures(featureName: String, opened: Boolean): void
setBackgroundColor(color: int): void
setBackgroundColor(red: int, green: int, blue: int): void
setBlue(blue: int): void
setGreen(green: int): void
setRed(red: int): void
setUsers(users: ArrayList): void
setUsers(users: Map): void

Player(rte: Rte, initialConfig: PlayerInitialConfig): unknown
getConfigs(config: PlayerConfig): void
getInfo(info: PlayerInfo): void
getPosition(): long
getStats(callback: PlayerGetStatsCallback): void
muteAudio(mute: boolean): void
muteVideo(mute: boolean): void
openWithUrl(url: String, startTime: long, callback: AsyncCallback): void
pause(): void
play(): void
preloadWithUrl(url: String): void
registerObserver(observer: PlayerObserver): void
seek(newTime: long): void
setCanvas(canvas: Canvas): void
setConfigs(config: PlayerConfig): void
stop(): void
switchWithUrl(url: String, syncPts: boolean, callback: AsyncCallback): void
unregisterObserver(observer: PlayerObserver): void

getAbrFallbackLayer(): Constants.AbrFallbackLayer
getAbrSubscriptionLayer(): Constants.AbrSubscriptionLayer
getAutoPlay(): boolean
getLoopCount(): int
getPlaybackSpeed(): int
getPlayoutVolume(): int
setAbrFallbackLayer(fallbackLayer: Constants.AbrFallbackLayer): void
setAbrSubscriptionLayer(subscriptionLayer: Constants.AbrSubscriptionLayer): void
setAutoPlay(autoPlay: boolean): void
setLoopCount(count: int): void
setPlaybackSpeed(speed: int): void
setPlayoutVolume(volume: int): void

onResult(playerStats: PlayerStats, error: Error): void

abrSubscriptionLayer(): Constants.AbrSubscriptionLayer
audioBitsPerSample(): int
audioChannels(): int
audioSampleRate(): int
currentUrl(): String
duration(): long
hasAudio(): boolean
hasVideo(): boolean
isAudioMuted(): boolean
isVideoMuted(): boolean
state(): int
streamCount(): int
videoHeight(): int
videoWidth(): int

onAudioVolumeIndication(volume: int): void
onEvent(event: int): void
onMetadata(type: int, data: byte[]): void
onPlayerInfoUpdated(info: PlayerInfo): void
onPositionChanged(curr_time: long, utc_time: long): void
onResolutionChanged(width: int, height: int): void
onStateChanged(old_state: int, new_state: int, error: Error): void