Lite SDK API 列表
- iOS
更新时间不可用
本页列出 Lite SDK 支持的 API 列表。
注意： 如果在本页中无法查询到你要使用的 API，则代表 Lite SDK 不支持该 API，调用该 API 时会返回错误码 -2。
AgoraRtcEngineKit
-
在
joinChannelByToken:channelId:uid:mediaOptions:joinSuccess: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
-
在
joinChannelByToken:channelId:userAccount:mediaOptions:joinSuccess: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
-
playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:
-
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:
-
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:
-
pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:
-
在
setAudioEncodedFrameDelegate:config: 中，
config 中的
encodingType 仅支持 OPUS 编码格式。
-
setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
-
setExternalAudioSource:sampleRate:channels:localPlayback:publish:
-
setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:
-
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:
-
setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
-
setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:
-
在
updateChannelWithMediaOptions: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
AgoraRtcEngineKit(Ex)
-
joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:
-
joinChannelExByToken:channelId:userAccount:delegate:mediaOptions:joinSuccess:
-
sendCustomReportMessageEx:category:event:label:value:connection:
-
在
updateChannelExWithMediaOptions:connection: 中，以下跟屏幕采集相关的参数设置无效：
- publishScreenCaptureVideo
- publishScreenCaptureAudio
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:connectionChangedToState: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
- onExtensionErrorWithContext:error:message:
- onEventWithContext:key:value:
- onExtensionStartedWithContext:
- onExtensionStoppedWithContext:
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。
- getMirrorApplied
- getObservedFramePosition
- getRotationApplied
- getVideoFormatPreference
- getVideoFrameProcessMode
- onCaptureVideoFrame:sourceType:
- onPreEncodeVideoFrame:sourceType:
- onRenderVideoFrame:uid:channelId:
AgoraMediaFilterEventDelegate
- onExtensionErrorWithContext:error:message:
- onEventWithContext:key:value:
- onExtensionStartedWithContext:
- onExtensionStoppedWithContext: