Lite SDK API 列表
本页列出 Lite SDK 支持的 API 列表。
注意
如果在本页中无法查询到你要使用的 API，则代表 Lite SDK 不支持该 API，调用该 API 时会返回错误码 -2。
AgoraRtcEngineKit
- adjustAudioMixingPlayoutVolume:
- adjustAudioMixingPublishVolume:
- adjustAudioMixingVolume:
- adjustCustomAudioPlayoutVolume:volume:
- adjustCustomAudioPublishVolume:volume:
- adjustPlaybackSignalVolume:
- adjustRecordingSignalVolume:
- adjustUserPlaybackSignalVolume:volume:
- complain:description:
- configRhythmPlayer:
- createCustomAudioTrack:config:
- createCustomVideoTrack
- createDataStream:reliable:ordered:
- createDataStream:config:
- createMediaPlayerWithDelegate:
- createMediaRecorder:
- delegate
- destroyCustomAudioTrack:
- destroyCustomVideoTrack:
- destroyMediaPlayer:
- disableAudio
- disableAudioSpectrumMonitor
- disableVideo
- enableAudio
- enableAudioSpectrumMonitor:
- enableAudioVolumeIndication:smooth:reportVad:
- enableContentInspect:config:
- enableCustomAudioLocalPlayback:enabled:
- enableDualStreamMode:
- enableDualStreamMode:streamConfig:
- enableEncryption:encryptionConfig:
- enableExtensionWithVendor:extension:enabled:sourceType:
- enableFaceDetection:
- enableInEarMonitoring:
- enableInEarMonitoring:includeAudioFilters:
- enableInstantMediaRendering
- enableLocalAudio:
- enableLocalVideo:
- enableMainQueueDispatch:
- enableMultiCamera:config:
- enableCameraCenterStage:
- enableSoundPositionIndication:
- enableVideo
- enableVideoImageSource:options:
- enableVoiceAITuner:type:
- enableWebSdkInteroperability:
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getAudioTrackCount
- getCallId
- cameraMaxZoomFactor
- getConnectionState
- getCurrentMonotonicTimeInMs
- getEffectCurrentPosition:
- getEffectDuration:
- getEffectsVolume
- getErrorDescription:
- getExtensionPropertyWithVendor:extension:key:
- getExtensionPropertyWithVendor:extension:key:sourceType:
- getNativeHandle
- getNetworkType
- getNtpWallTimeInMs
- getUserInfoByUid:withError:
- getUserInfoByUserAccount:withError:
- getSdkVersion
- getVolumeOfEffect:
- sharedEngineWithConfig:delegate:
- isCameraAutoExposureFaceModeSupported
- isCameraAutoFocusFaceModeSupported
- isCameraExposurePositionSupported
- isCameraExposureSupported
- isCameraFocusPositionInPreviewSupported
- isCameraTorchSupported
- isCameraZoomSupported
- isFeatureAvailableOnDevice:
- isSpeakerphoneEnabled
- isCameraCenterStageSupported
- joinChannelByToken:channelId:info:uid:joinSuccess:
- 在 joinChannelByToken:channelId:uid:mediaOptions:joinSuccess: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- joinChannelByToken:channelId:userAccount:joinSuccess:
- 在 joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- leaveChannel:
- leaveChannel:leaveChannelBlock:
- muteAllRemoteAudioStreams:
- muteAllRemoteVideoStreams:
- muteLocalAudioStream:
- muteLocalVideoStream:
- muteRemoteAudioStream:mute:
- muteRemoteVideoStream:mute:
- pauseAllChannelMediaRelay
- pauseAllEffects
- pauseAudioMixing
- pauseEffect:
- playEffect:filePath:loopCount:pitch:pan:gain:
- playEffect:filePath:loopCount:pitch:pan:gain:publish:
- playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:
- preloadChannelByToken:channelId:uid:
- preloadChannelByTokenWithUserAccount:channelId:userAccount:
- preloadEffect:filePath:
- pullPlaybackAudioFrameRawData:lengthInByte:
- pullPlaybackAudioFrameSampleBufferByLengthInByte:
- pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:
- pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:
- pushExternalAudioFrameSampleBuffer:
- pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:
- pushExternalVideoFrame:videoTrackId:
- pushExternalVideoFrame:
- queryCameraFocalLengthCapability
- queryCodecCapability
- queryDeviceScore
- rate:rating:description:
- 在 setAudioEncodedFrameDelegate:config: 中，config 中的 encodingType 仅支持 OPUS 编码格式。
- setAudioFrameDelegate:
- registerAudioSpectrumDelegate:
- registerExtensionWithVendor:extension:sourceType:
- registerLocalUserAccountWithAppID:userAccount:
- setMediaMetadataDelegate:withType:
- setEncodedVideoFrameDelegate:
- setVideoFrameDelegate:
- destroy
- renewToken:
- resumeAllChannelMediaRelay
- resumeAllEffects
- resumeAudioMixing
- resumeEffect:
- selectAudioTrack:
- sendCustomReportMessage:category:event:label:value:
- sendStreamMessage:data:
- setAdvancedAudioOptions:
- setAudioEffectParameters:param1:param2:
- setAudioEffectPreset:
- setAudioMixingDualMonoMode:
- setAudioMixingPitch:
- setAudioMixingPosition:
- setAudioMixingPlaybackSpeed:
- setAudioProfile:scenario:
- setAudioProfile:
- setAudioScenario:
- setAudioSessionOperationRestriction:
- setAVSyncSource:uid:
- setCameraAutoExposureFaceModeEnabled
- setCameraAutoFocusFaceModeEnabled:
- setCameraCapturerConfiguration:
- setCameraExposureFactor:
- setCameraExposurePosition:
- setCameraFocusPositionInPreview:
- setCameraStabilizationMode:
- setCameraTorchOn:
- setCameraZoomFactor:
- setChannelProfile:
- setClientRole:
- setClientRole:options:
- setCloudProxy:
- setColorEnhanceOptions:options:
- setColorEnhanceOptions:options:sourceType:
- setDefaultAudioRouteToSpeakerphone:
- setDualStreamMode:
- setDualStreamMode:streamConfig:
- setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
- setEffectPosition:pos:
- setEffectsVolume:
- setEnableSpeakerphone:
- setExtensionPropertyWithVendor:extension:key:value:
- setExtensionProviderPropertyWithVendor:key:value:
- enableExternalAudioSink:sampleRate:channels:
- enableExternalAudioSink:sampleRate:channels:
- setExternalAudioSource:sampleRate:channels:
- setExternalAudioSource:sampleRate:channels:localPlayback:publish:
- setExternalVideoSource:useTexture:sourceType:
- setHeadphoneEQParameters:highGain:
- setHeadphoneEQPreset:
- setInEarMonitoringVolume:
- setLocalAccessPoint:
- setLocalRenderMode:mode:
- setLocalRenderMode:mirror:
- setLocalVideoMirrorMode:
- setLocalVoiceEqualizationOfBandFrequency:withGain:
- setLocalVoiceFormant:
- setLocalVoicePitch:
- setLocalVoiceReverbOfType:withValue:
- setLogFile:
- setLogFileSize:
- setLogFilter:
- setLogLevel:
- setLowlightEnhanceOptions:options:
- setLowlightEnhanceOptions:options:sourceType:
- setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:
- setParameters:
- setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:
- setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
- setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
- setRemoteDefaultVideoStreamType:
- setRemoteRenderMode:mode:mirror:
- setRemoteSubscribeFallbackOption:
- setRemoteVideoStream:type:
- setRemoteVideoSubscriptionOptions:options:
- setRemoteVoicePosition:pan:gain:
- setSubscribeAudioAllowlist:
- setSubscribeAudioBlocklist:
- setSubscribeVideoAllowlist:
- setSubscribeVideoBlocklist:
- setupLocalVideo:
- setupRemoteVideo:
- setVideoDenoiserOptions:options:
- setVideoDenoiserOptions:options:sourceType:
- setVideoEncoderConfiguration:
- setVideoResolution:andFrameRate:bitrate:
- setVideoScenario:
- setVoiceBeautifierParameters:param1:param2:
- setVoiceBeautifierPreset:
- setVoiceConversionPreset:
- setVolumeOfEffect:withVolume:
- startAudioMixing:loopback:cycle:
- startAudioMixing:loopback:cycle:startPos:
- startEchoTestWithConfig:
- startLastmileProbeTest:
- startLocalVideoTranscoder:
- startOrUpdateChannelMediaRelay:
- startPreview
- startPreview:
- startCameraCapture:config:
- startRhythmPlayer:sound2:config:
- startMediaRenderingTracing
- stopAllEffects
- stopAudioMixing
- stopChannelMediaRelay
- stopEchoTest
- stopEffect:
- stopLastmileProbeTest
- stopPreview
- stopPreview:
- stopCameraCapture:
- stopRhythmPlayer
- switchCamera
- unloadEffect:
- unregisterAudioSpectrumDelegate:
- 在 updateChannelWithMediaOptions: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- updateLocalTranscoderConfiguration:
- updatePreloadChannelToken:
- updateScreenCapture:
AgoraRtcEngineKitEx
- enableAudioVolumeIndicationEx:smooth:reportVad:connection:
- enableContentInspectEx:config:connection:
- enableDualStreamModeEx:streamConfig:connection:
- enableEncryptionEx:encryptionConfig:connection:
- getCallIdEx:
- getConnectionStateEx:
- getUserInfoWithUserId:userInfo:channelId:localUserAccount:
- getUserInfoWithUserAccount:userInfo:channelId:localUserAccount:
- joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:
- joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:
- leaveChannelEx:leaveChannelBlock:
- leaveChannelEx:options:leaveChannelBlock:
- muteAllRemoteAudioStreamsEx:connection:
- muteAllRemoteVideoStreamsEx:connection:
- muteLocalAudioStreamEx:connection:
- muteLocalVideoStreamEx:connection:
- muteRemoteAudioStreamEx:mute:connection:
- muteRemoteVideoStreamEx:mute:connection:
- pauseAllChannelMediaRelayEx:
- resumeAllChannelMediaRelayEx:
- sendCustomReportMessageEx:category:event:label:value:connection:
- setDualStreamModeEx:streamConfig:connection:
- setRemoteRenderModeEx:mode:mirror:connection:
- setRemoteVideoStreamEx:type:connection:
- setRemoteVoicePosition:pan:gain:connection:
- setSubscribeAudioBlocklistEx:connection:
- setSubscribeAudioAllowlistEx:connection:
- setSubscribeVideoBlocklistEx:connection:
- setSubscribeVideoAllowlistEx:connection:
- setupRemoteVideoEx:connection:
- setVideoEncoderConfigurationEx:connection:
- startMediaRenderingTracingEx:
- startOrUpdateChannelMediaRelayEx:connection:
- stopChannelMediaRelayEx:
- 在 updateChannelExWithMediaOptions:connection: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
- setRemoteVideoSubscriptionOptionsEx:options:connection:
- adjustUserPlaybackSignalVolumeEx:volume:connection:
AgoraRtcEngineDelegate
- rtcEngine:activeSpeaker:
- rtcEngineDidAudioEffectFinish:soundId:
- rtcEngineLocalAudioMixingDidFinish:
- rtcEngine:audioMixingPositionChanged:
- rtcEngine:audioMixingStateChanged:reasonCode:
- rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:
- audioQualityBlock:
- rtcEngine:didAudioRouteChanged:
- rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:
- rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:
- rtcEngine:cameraExposureDidChangedToRect:
- rtcEngine:cameraFocusDidChangedToRect:
- rtcEngineCameraDidReady:
- rtcEngine:channelMediaRelayStateDidChange:error:
- rtcEngine:didClientRoleChanged:newRole:newRoleOptions:
- rtcEngine:didClientRoleChangeFailed:currentRole:
- rtcEngineConnectionDidBanned:
- rtcEngineConnectionDidInterrupted:
- rtcEngineConnectionDidLost:
- rtcEngine:connectionStateChanged:reason:
- rtcEngine:didOccurEncryptionError:
- rtcEngine:didOccurError:
- rtcEngine:facePositionDidChangeWidth:previewHeight:faces:
- rtcEngine:firstLocalAudioFramePublished:
- rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:
- rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:
- rtcEngine:firstRemoteAudioFrameOfUid:elapsed:
- rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:
- rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:
- rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:
- rtcEngine:didJoinChannel:withUid:elapsed:
- rtcEngine:lastmileProbeTestResult:
- rtcEngine:lastmileQuality:
- rtcEngine:didLeaveChannelWithStats:
- rtcEngine:localAudioStateChanged:reason:
- rtcEngine:localAudioStats:
- rtcEngine:didLocalUserRegisteredWithUserId:userAccount:
- rtcEngine:localVideoStateChangedOfState:reason:sourceType:
- rtcEngine:localVideoStats:sourceType:
- rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:
- rtcEngine:didTranscodedStreamLayoutInfoUpdatedWithUserId:videoLayoutInfo:
- rtcEngine:networkQuality:txQuality:rxQuality:
- rtcEngine:networkTypeChanged:
- rtcEngine:permissionError:
- rtcEngine:didRejoinChannel:withUid:elapsed:
- rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:
- rtcEngine:remoteAudioStats:
- rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:
- rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:
- rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:
- rtcEngine:remoteVideoStats:
- rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:
- rtcEngineRequestToken:
- rtcEngine:didRhythmPlayerStateChanged:reason:
- rtcEngine:reportRtcStats:
- rtcEngine:receiveStreamMessageFromUid:streamId:data:
- rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:
- rtcEngine:tokenPrivilegeWillExpire:
- rtcEngineTranscodingUpdated:
- rtcEngine:uplinkNetworkInfoUpdate:
- rtcEngine:didLocalVideoEnabled:byUid:
- rtcEngine:didVideoEnabled:byUid:
- rtcEngine:didUserInfoUpdatedWithUserId:userInfo:
- rtcEngine:didJoinedOfUid:elapsed:
- rtcEngine:didAudioMuted:byUid:
- rtcEngine:didVideoMuted:byUid:
- rtcEngine:didOfflineOfUid:reason:
- rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:
- rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:
- rtcEngineVideoDidStop:
- rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:
- rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:
AgoraMediaFilterEventDelegate
AgoraRtcMediaPlayerProtocol
注意
媒体播放器中的 API 仅支持处理音频媒体文件、不支持处理视频媒体文件。
- adjustPlayoutVolume:
- adjustPublishSignalVolume:
- getDuration
- getMediaPlayerId
- getMute
- getPlayoutVolume
- getPosition
- getPlaySrc
- getPublishSignalVolume
- getPlayerState
- getStreamCount
- getStreamByIndex:
- mute:
- open:startPos:
- openWithMediaSource:
- pause
- play
- playPreloadedSrc:
- preloadSrc:startPos:
- resume
- seekToPosition:
- selectAudioTrack:
- selectMultiAudioTrack:publishTrackIndex:
- setAudioPitch:
- setAudioDualMonoMode:
- setVideoFrameDelegate:
- setLoopCount:
- setPlaybackSpeed:
- setPlayerOption:value:
- setPlayerOptionString:value:
- setRenderMode:
- setView:
- stop
- switchSrc:syncPts:
- unloadSrc:
AgoraEncodedVideoFrameDelegate
AgoraVideoFrameDelegate
注意
通过 onCaptureVideoFrame:sourceType:、onPreEncodeVideoFrame:sourceType: 和 onRenderVideoFrame:uid:channelId: 回调返回的视频数据中，alphabuffer 为
nil。