![]() |
AlivcLivePusher_Interactive v6.17.0
Aliyun Live Pusher Interactive SDK API Reference Manual for iOS Platforms
|
Functions | |
typedef | NS_ENUM (NSInteger, AliLiveAudioEffectBeautifyMode) |
typedef | NS_ENUM (NSInteger, AliLiveAudioEffectEqualizationBandFrequency) |
typedef | NS_ENUM (NSInteger, AliLiveAudioEffectReverbParamType) |
typedef | NS_ENUM (NSInteger, AliLiveAudioFrameObserverOperationMode) |
typedef | NS_ENUM (NSInteger, AliLiveAudioSource) |
typedef | NS_ENUM (NSInteger, AliLiveConnectionStatus) |
typedef | NS_ENUM (NSInteger, AliLiveConnectionStatusChangeReason) |
typedef | NS_ENUM (NSInteger, AliLiveLocalAudioStateType) |
typedef | NS_ENUM (NSInteger, AliLiveLocalVideoStateType) |
typedef | NS_ENUM (NSInteger, AliLiveMuteLocalAudioMode) |
typedef | NS_ENUM (NSInteger, AliLivePublishState) |
typedef | NS_ENUM (NSInteger, AliLiveSubscribeState) |
typedef | NS_ENUM (NSInteger, AliLiveUserOfflineReason) |
typedef | NS_ENUM (NSInteger, AliLiveVideoSource) |
typedef | NS_ENUM (NSInteger, AlivcLiveAudioProfile) |
audio profile model AlivcLiveAudioProfileLowQualityMode Audio low quality mode, default 8000Hz sampling rate, mono, maximum encoding rate 12kbps AlivcLiveAudioProfileBasicQualityMode Standard sound quality mode, default 16000Hz sampling rate, mono, maximum encoding rate 24kbps AlivcLiveAudioProfileQualityMode (Default) High quality mode, default 48000Hz sampling rate, mono, maximum encoding rate 64kbps AlivcLiveAudioProfileStereoHighQualityMode Stereo high quality mode, default 48000Hz sampling rate, two-channel, maximum encoding rate 80kbps AlivcLiveAudioProfileSuperHighQualityMode Ultra-sound quality mode, default 48000Hz sampling rate, mono, maximum encoding rate 96kbps AlivcLiveAudioProfileStereoSuperHighQualityMode Stereo super high quality mode, default 48000Hz sampling rate, two-channel, maximum encoding rate 128kbps | |
typedef | NS_ENUM (NSInteger, AlivcLiveBufferType) |
video format type | |
typedef | NS_ENUM (NSInteger, AlivcLiveChannelProfile) |
typedef | NS_ENUM (NSInteger, AlivcLiveLicenseCheckResultCode) |
SDK License Check Result Code. | |
typedef | NS_ENUM (NSInteger, AlivcLiveMixSourceType) |
Mixed member stream type AlivcLiveMixSourceTypeCamera Mix camera video AlivcLiveMixSourceTypeScreen Mix screen. | |
typedef | NS_ENUM (NSInteger, AlivcLiveMixStreamType) |
Mixed member stream type AlivcLiveMixStreamTypeAudioVideo Mix audio and video AlivcLiveMixStreamTypePureAudio Mix audio, don't mix video AlivcLiveMixStreamTypePureVideo Mix video, don't mix audio. | |
typedef | NS_ENUM (NSInteger, AlivcLivePlayerError) |
Live interaction player engine play error code. | |
typedef | NS_ENUM (NSInteger, AlivcLivePlayRotationMode) |
The video rotation angle. | |
typedef | NS_ENUM (NSInteger, AlivcLivePlayVideoStreamType) |
The video stream type. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioChannel) |
Audio channel number. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioEffectReverbMode) |
Sound Reverb Mode AlivcLivePushAudioEffectReverb_Off turn off reverb AlivcLivePushAudioEffectReverb_Vocal_I vocal I AlivcLivePushAudioEffectReverb_Vocal_II vocal II AlivcLivePushAudioEffectReverb_Bathroom bath room AlivcLivePushAudioEffectReverb_Small_Room_Bright small bright room AlivcLivePushAudioEffectReverb_Small_Room_Dark samll dark room AlivcLivePushAudioEffectReverb_Medium_Room AlivcLivePushAudioEffectReverb_Large_Room large room AlivcLivePushAudioEffectReverb_Church_Hall church hall AlivcLivePushAudioEffectReverb_Mode_Max max. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioEffectVoiceChangeMode) |
Voice Changer Mode AlivcLivePushAudioEffectvVoiceChange_OFF turn off voice changer AlivcLivePushAudioEffectvVoiceChange_OLD_MAN old man AlivcLivePushAudioEffectvVoiceChange_BABYBOY baby boy AlivcLivePushAudioEffectvVoiceChange_BABYGILR baby girl AlivcLivePushAudioEffectvVoiceChange_ROBOT robot AlivcLivePushAudioEffectvVoiceChange_DAIMO demon king AlivcLivePushAudioEffectvVoiceChange_KTV KTV AlivcLivePushAudioEffectvVoiceChangeR_ECHO echo AlivcLivePushAudioEffectvVoiceChange_MAX max. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioEncoderCodec) |
Audio encoder codec. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioEncoderMode) |
Audio encoder mode. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioEncoderProfile) |
Audio encoder profile. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioFormat) |
typedef | NS_ENUM (NSInteger, AlivcLivePushAudioSampleRate) |
Audio sample rate. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushCameraType) |
Camera type. | |
typedef | NS_ENUM (NSInteger, AlivcLivePusherAudioScenario) |
Audio scenario. | |
typedef | NS_ENUM (NSInteger, AlivcLivePusherAudioSessionOperationRestriction) |
Audio Session OperationRestriction. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushFPS) |
typedef | NS_ENUM (NSInteger, AlivcLivePushKickedOutType) |
The specific reason for being kicked out AlivcLivePushKickedOutTypeKickedOut The current user is kicked out of the room and needs to exit the live broadcast room AlivcLivePushKickedOutTypeChannelTerminated The live room is deleted, you need to exit the live room AlivcLivePushKickedOutTypeUserReplaced The same userID enters the live broadcast room on other devices, and the current device is offline. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushLogLevel) |
SDK log level. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushMode) |
Supported modes: | |
typedef | NS_ENUM (NSInteger, AlivcLivePushMonitorLevel) |
SDK The SDK provides quality monitoring. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushOrientation) |
Push orientation. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushPublishType) |
Live push protocol. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushQualityMode) |
Push quality mode. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushResolution) |
Resolution. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushScallingMode) |
Scalling Mode. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushStatus) |
live pusher engine status | |
typedef | NS_ENUM (NSInteger, AlivcLivePushUserRole) |
The user role. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushVideoEncodeGOP) |
video gop | |
typedef | NS_ENUM (NSInteger, AlivcLivePushVideoEncoderMode) |
Video Encoder Mode. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushVideoEncoderModeHardCodec) |
Video encoder type. | |
typedef | NS_ENUM (NSInteger, AlivcLivePushVideoFormat) |
typedef | NS_ENUM (NSInteger, AlivcLiveRecordAudioQuality) |
Local recoded audio quality AlivcLiveRecordAudioQualityLow Low-quality file recording, small file size, average sound quality AlivcLiveRecordAudioQualityMidium Medium quality file recording, medium file size, medium sound quality AlivcLiveRecordAudioQualityHigh High-quality file recording, larger file size and better sound quality. | |
typedef | NS_ENUM (NSInteger, AlivcLiveRecordFormat) |
Local recording format AlivcLiveRecordFormatAAC Record audio-only AAC format files AlivcLiveRecordFormatWAV Record audio-only WAV format files AlivcLiveRecordFormatMP4 Record MP4 format files containing audio and video. | |
typedef | NS_ENUM (NSInteger, AlivcLiveRecordMediaEventCode) |
Local recording status and error callback AlivcLiveRecordMediaEventCodeTimeOverLimit Exceeds the set maxDuration AlivcLiveRecordMediaEventCodeSizeOverLimit Exceeds set file maxSize AlivcLiveRecordMediaEventCodeOutOfSize Block files exceeding 2G AlivcLiveRecordMediaEventCodeWriteFailed Failed to write file AlivcLiveRecordMediaEventCodeStart Start recording AlivcLiveRecordMediaEventCodeStop Stop recording. | |
typedef | NS_ENUM (NSInteger, AlivcLiveRecordType) |
Local recode media type AlivcLiveRecordTypePureAudio only recode audio AlivcLiveRecordTypeAudioAndVideo recode audio and video. | |
typedef | NS_ENUM (NSInteger, AlivcLiveTranscodingCropMode) |
mixed-stream transcoding | |
typedef | NS_ENUM (NSInteger, AlivcLiveVideoCodecManufacturer) |
typedef | NS_ENUM (NSInteger, AlivcPusherErrorCode) |
Error code. | |
typedef | NS_ENUM (NSInteger, AlivcPusherPreviewDisplayMode) |
Preview Display Mde. | |
typedef | NS_ENUM (NSUInteger, AliLiveAudioStreamType) |
typedef | NS_ENUM (NSUInteger, AliLiveRenderMode) |
typedef | NS_ENUM (NSUInteger, AliLiveVideoPipelineMirrorMode) |
typedef | NS_ENUM (NSUInteger, AlivcLiveNetworkQuality) |
Network quality AlivcLiveNetworkQualityExcellent The network is excellent, and the stream definition and quality are good AlivcLiveNetworkQualityGood The network is good, and the fluency and clarity are about the same as excellent AlivcLiveNetworkQualityPoor The network is poor, and the audio and video fluency and clarity are flawed, which does not affect communication AlivcLiveNetworkQualityBad The network is poor, the video freezes seriously, but the audio can communicate normally AlivcLiveNetworkQualityVeryBad The network is extremely poor, and it is basically impossible to communicate AlivcLiveNetworkQualityDisconnect Network interruption AlivcLiveNetworkQualityUnknow Unknow. | |
typedef | NS_ENUM (NSUInteger, AlivcLivePlayRenderMode) |
The view render mode. | |
typedef | NS_OPTIONS (NSInteger, AliLiveAudioFrameObserverUserDefinedInfoBitMask) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveAudioEffectBeautifyMode | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveAudioEffectEqualizationBandFrequency | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveAudioEffectReverbParamType | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveAudioFrameObserverOperationMode | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveAudioSource | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveConnectionStatus | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveConnectionStatusChangeReason | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveLocalAudioStateType | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveLocalVideoStateType | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveMuteLocalAudioMode | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLivePublishState | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveSubscribeState | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveUserOfflineReason | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AliLiveVideoSource | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveAudioProfile | |||
) |
audio profile model AlivcLiveAudioProfileLowQualityMode Audio low quality mode, default 8000Hz sampling rate, mono, maximum encoding rate 12kbps AlivcLiveAudioProfileBasicQualityMode Standard sound quality mode, default 16000Hz sampling rate, mono, maximum encoding rate 24kbps AlivcLiveAudioProfileQualityMode (Default) High quality mode, default 48000Hz sampling rate, mono, maximum encoding rate 64kbps AlivcLiveAudioProfileStereoHighQualityMode Stereo high quality mode, default 48000Hz sampling rate, two-channel, maximum encoding rate 80kbps AlivcLiveAudioProfileSuperHighQualityMode Ultra-sound quality mode, default 48000Hz sampling rate, mono, maximum encoding rate 96kbps AlivcLiveAudioProfileStereoSuperHighQualityMode Stereo super high quality mode, default 48000Hz sampling rate, two-channel, maximum encoding rate 128kbps
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveBufferType | |||
) |
video format type
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveChannelProfile | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveLicenseCheckResultCode | |||
) |
SDK License Check Result Code.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveMixSourceType | |||
) |
Mixed member stream type AlivcLiveMixSourceTypeCamera Mix camera video AlivcLiveMixSourceTypeScreen Mix screen.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveMixStreamType | |||
) |
Mixed member stream type AlivcLiveMixStreamTypeAudioVideo Mix audio and video AlivcLiveMixStreamTypePureAudio Mix audio, don't mix video AlivcLiveMixStreamTypePureVideo Mix video, don't mix audio.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePlayerError | |||
) |
Live interaction player engine play error code.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePlayRotationMode | |||
) |
The video rotation angle.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePlayVideoStreamType | |||
) |
The video stream type.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioChannel | |||
) |
Audio channel number.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioEffectReverbMode | |||
) |
Sound Reverb Mode AlivcLivePushAudioEffectReverb_Off turn off reverb AlivcLivePushAudioEffectReverb_Vocal_I vocal I AlivcLivePushAudioEffectReverb_Vocal_II vocal II AlivcLivePushAudioEffectReverb_Bathroom bath room AlivcLivePushAudioEffectReverb_Small_Room_Bright small bright room AlivcLivePushAudioEffectReverb_Small_Room_Dark samll dark room AlivcLivePushAudioEffectReverb_Medium_Room AlivcLivePushAudioEffectReverb_Large_Room large room AlivcLivePushAudioEffectReverb_Church_Hall church hall AlivcLivePushAudioEffectReverb_Mode_Max max.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioEffectVoiceChangeMode | |||
) |
Voice Changer Mode AlivcLivePushAudioEffectvVoiceChange_OFF turn off voice changer AlivcLivePushAudioEffectvVoiceChange_OLD_MAN old man AlivcLivePushAudioEffectvVoiceChange_BABYBOY baby boy AlivcLivePushAudioEffectvVoiceChange_BABYGILR baby girl AlivcLivePushAudioEffectvVoiceChange_ROBOT robot AlivcLivePushAudioEffectvVoiceChange_DAIMO demon king AlivcLivePushAudioEffectvVoiceChange_KTV KTV AlivcLivePushAudioEffectvVoiceChangeR_ECHO echo AlivcLivePushAudioEffectvVoiceChange_MAX max.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioEncoderCodec | |||
) |
Audio encoder codec.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioEncoderMode | |||
) |
Audio encoder mode.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioEncoderProfile | |||
) |
Audio encoder profile.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioFormat | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushAudioSampleRate | |||
) |
Audio sample rate.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushCameraType | |||
) |
Camera type.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePusherAudioScenario | |||
) |
Audio scenario.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePusherAudioSessionOperationRestriction | |||
) |
Audio Session OperationRestriction.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushFPS | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushKickedOutType | |||
) |
The specific reason for being kicked out AlivcLivePushKickedOutTypeKickedOut The current user is kicked out of the room and needs to exit the live broadcast room AlivcLivePushKickedOutTypeChannelTerminated The live room is deleted, you need to exit the live room AlivcLivePushKickedOutTypeUserReplaced The same userID enters the live broadcast room on other devices, and the current device is offline.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushLogLevel | |||
) |
SDK log level.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushMode | |||
) |
Supported modes:
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushMonitorLevel | |||
) |
SDK The SDK provides quality monitoring.
For embedment scenarios, you can specify specific monitoring metrics AlivcLivePushMonitorLevelAll monitoring all quality information AlivcLivePushMonitorLevelCut monitoring cut quality information AlivcLivePushMonitorLevelNone monitoring none quality information
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushOrientation | |||
) |
Push orientation.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushPublishType | |||
) |
Live push protocol.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushQualityMode | |||
) |
Push quality mode.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushResolution | |||
) |
Resolution.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushScallingMode | |||
) |
Scalling Mode.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushStatus | |||
) |
live pusher engine status
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushUserRole | |||
) |
The user role.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushVideoEncodeGOP | |||
) |
video gop
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushVideoEncoderMode | |||
) |
Video Encoder Mode.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushVideoEncoderModeHardCodec | |||
) |
Video encoder type.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLivePushVideoFormat | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveRecordAudioQuality | |||
) |
Local recoded audio quality AlivcLiveRecordAudioQualityLow Low-quality file recording, small file size, average sound quality AlivcLiveRecordAudioQualityMidium Medium quality file recording, medium file size, medium sound quality AlivcLiveRecordAudioQualityHigh High-quality file recording, larger file size and better sound quality.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveRecordFormat | |||
) |
Local recording format AlivcLiveRecordFormatAAC Record audio-only AAC format files AlivcLiveRecordFormatWAV Record audio-only WAV format files AlivcLiveRecordFormatMP4 Record MP4 format files containing audio and video.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveRecordMediaEventCode | |||
) |
Local recording status and error callback AlivcLiveRecordMediaEventCodeTimeOverLimit Exceeds the set maxDuration AlivcLiveRecordMediaEventCodeSizeOverLimit Exceeds set file maxSize AlivcLiveRecordMediaEventCodeOutOfSize Block files exceeding 2G AlivcLiveRecordMediaEventCodeWriteFailed Failed to write file AlivcLiveRecordMediaEventCodeStart Start recording AlivcLiveRecordMediaEventCodeStop Stop recording.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveRecordType | |||
) |
Local recode media type AlivcLiveRecordTypePureAudio only recode audio AlivcLiveRecordTypeAudioAndVideo recode audio and video.
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveTranscodingCropMode | |||
) |
mixed-stream transcoding
typedef NS_ENUM | ( | NSInteger | , |
AlivcLiveVideoCodecManufacturer | |||
) |
typedef NS_ENUM | ( | NSInteger | , |
AlivcPusherErrorCode | |||
) |
Error code.
typedef NS_ENUM | ( | NSInteger | , |
AlivcPusherPreviewDisplayMode | |||
) |
Preview Display Mde.
typedef NS_ENUM | ( | NSUInteger | , |
AliLiveAudioStreamType | |||
) |
typedef NS_ENUM | ( | NSUInteger | , |
AliLiveRenderMode | |||
) |
typedef NS_ENUM | ( | NSUInteger | , |
AliLiveVideoPipelineMirrorMode | |||
) |
typedef NS_ENUM | ( | NSUInteger | , |
AlivcLiveNetworkQuality | |||
) |
Network quality AlivcLiveNetworkQualityExcellent The network is excellent, and the stream definition and quality are good AlivcLiveNetworkQualityGood The network is good, and the fluency and clarity are about the same as excellent AlivcLiveNetworkQualityPoor The network is poor, and the audio and video fluency and clarity are flawed, which does not affect communication AlivcLiveNetworkQualityBad The network is poor, the video freezes seriously, but the audio can communicate normally AlivcLiveNetworkQualityVeryBad The network is extremely poor, and it is basically impossible to communicate AlivcLiveNetworkQualityDisconnect Network interruption AlivcLiveNetworkQualityUnknow Unknow.
typedef NS_ENUM | ( | NSUInteger | , |
AlivcLivePlayRenderMode | |||
) |
The view render mode.
typedef NS_OPTIONS | ( | NSInteger | , |
AliLiveAudioFrameObserverUserDefinedInfoBitMask | |||
) |