AlivcLivePusher_Interactive v6.17.0
Aliyun Live Pusher Interactive SDK API Reference Manual for iOS Platforms
Loading...
Searching...
No Matches
<AlivcLivePusherInfoDelegate> Protocol Reference

Callbacks related to stream pusher basic info. More...

#include "AlivcLivePusher.h"

Inheritance diagram for <AlivcLivePusherInfoDelegate>:

Instance Methods

(void) - onAudioPublishStateChanged:oldState:newState:
 The callback for the audio frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onFirstFramePreviewed:
 The callback for first frame rendering.
 
(void) - onFirstFramePushed:
 The callback for the first frame being sent.
 
(void) - onJoinChannelResult:result:channel:userId:
 Join channel callback.
 
(void) - onKickedOutByServer:reason:
 The reason for being kicked out by the server callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onLocalAudioStateChanged:state:message:
 Local audio record device status callback.
 
(void) - onLocalDualAudioStreamPushState:state:
 The callback for the the second audio stream push state Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onLocalVideoStateChanged:state:message:
 Local video capture device status callback.
 
(void) - onMediaRecordEvent:event:recoderStoragePath:
 
(void) - onMicrophoneVolumeUpdate:volume:
 Microphone volume callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onPreviewStarted:
 The callback for preview start.
 
(void) - onPreviewStoped:
 The callback for preview stop.
 
(void) - onPushPaused:
 The callback for pause of stream pusher from the camera.
 
(void) - onPushRestart:
 The callback for restart of stream push.
 
(void) - onPushResumed:
 The callback for resume of stream push from the camera.
 
(void) - onPushStarted:
 The callback for start of stream push.
 
(void) - onPushStatistics:statsInfo:
 The callback for statistics on stream push.
 
(void) - onPushStoped:
 The callback for end of stream push.
 
(void) - onRemoteUserAudioStream:userId:state:
 A user opens a audio stream callback in the room Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onRemoteUserEnterRoom:userId:state:
 A user room has been added to the callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onRemoteUserVideoStream:userId:type:state:
 A user opens a camera stream or share screen stream callback in the room, which can be a screen sharing stream or a unity stream Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onScreenSharePublishStateChanged:oldState:newState:
 The callback for the screen frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onSetLiveMixTranscodingConfig:status:message:
 The callback for mixed-stream transcoding, which corresponds to the setLiveMixTranscodingConfig method Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 
(void) - onVideoPublishStateChanged:oldState:newState:
 The callback for the video frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.
 

Detailed Description

Callbacks related to stream pusher basic info.

Method Documentation

◆ onAudioPublishStateChanged:oldState:newState:

- (void) onAudioPublishStateChanged: (AlivcLivePusher *)  pusher
oldState: (AliLivePublishState)  oldState
newState: (AliLivePublishState)  newState 
optional

The callback for the audio frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
oldStatePrevious push status,See AliLivePublishState
newStateCurrent push status,See AliLivePublishState

◆ onFirstFramePreviewed:

- (void) onFirstFramePreviewed: (AlivcLivePusher *)  pusher
optional

The callback for first frame rendering.

Parameters
pusherThe live pusher engine object

◆ onFirstFramePushed:

- (void) onFirstFramePushed: (AlivcLivePusher *)  pusher
optional

The callback for the first frame being sent.

Parameters
pusherThe live pusher engine object

◆ onJoinChannelResult:result:channel:userId:

- (void) onJoinChannelResult: (AlivcLivePusher *)  pusher
result: (int)  result
channel: (NSString *_Nonnull)  channel
userId: (NSString *_Nonnull)  userId 
optional

Join channel callback.

When startPushWithURL is called in interactive mode, the RTC channel will be added first. This callback indicates success/failure to join the channel and returns relevant information about channel joining

Parameters
pusherThe live pusher engine object
resultJoin channel results 0:success != 0:failure
channelchannel id
userIduser id

◆ onKickedOutByServer:reason:

- (void) onKickedOutByServer: (AlivcLivePusher *)  pusher
reason: (AlivcLivePushKickedOutType)  code 
optional

The reason for being kicked out by the server callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherpusher The live pusher engine object
codeThe specific reason for being kicked out

◆ onLocalAudioStateChanged:state:message:

- (void) onLocalAudioStateChanged: (AlivcLivePusher *)  pusher
state: (AliLiveLocalAudioStateType)  state
message: (NSString *_Nullable)  msg 
optional

Local audio record device status callback.

Parameters
pusherThe live pusher engine object
stateDevice status, AliLiveLocalAudioStateType type
Note
The result callbacks of startAudioCapture and stopAudioCapture

◆ onLocalDualAudioStreamPushState:state:

- (void) onLocalDualAudioStreamPushState: (AlivcLivePusher *)  pusher
state: (BOOL)  isPushing 
optional

The callback for the the second audio stream push state Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
isPushingpush state:YES start pushing,NO stop push

◆ onLocalVideoStateChanged:state:message:

- (void) onLocalVideoStateChanged: (AlivcLivePusher *)  pusher
state: (AliLiveLocalVideoStateType)  state
message: (NSString *_Nullable)  msg 
optional

Local video capture device status callback.

Parameters
pusherThe live pusher engine object
stateDevice status, AliLiveLocalVideoStateType type
Note
The result callbacks of enableLocalCamera

◆ onMediaRecordEvent:event:recoderStoragePath:

- (void) onMediaRecordEvent: (AlivcLivePusher *)  pusher
event: (AlivcLiveRecordMediaEventCode)  event
recoderStoragePath: (NSString *_Nullable)  storagePath 
optional

◆ onMicrophoneVolumeUpdate:volume:

- (void) onMicrophoneVolumeUpdate: (AlivcLivePusher *)  pusher
volume: (int)  volume 
optional

Microphone volume callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
volumevolume, value [0,255]
Note
After calling enableAudioVolumeIndication to enable the volume callback frequency, you will receive this callback notification.

◆ onPreviewStarted:

- (void) onPreviewStarted: (AlivcLivePusher *)  pusher
optional

The callback for preview start.

Parameters
pusherThe live pusher engine object

◆ onPreviewStoped:

- (void) onPreviewStoped: (AlivcLivePusher *)  pusher
optional

The callback for preview stop.

Parameters
pusherThe live pusher engine object

◆ onPushPaused:

- (void) onPushPaused: (AlivcLivePusher *)  pusher
optional

The callback for pause of stream pusher from the camera.

Parameters
pusherThe live pusher engine object

◆ onPushRestart:

- (void) onPushRestart: (AlivcLivePusher *)  pusher
optional

The callback for restart of stream push.

Parameters
pusherThe live pusher engine object

◆ onPushResumed:

- (void) onPushResumed: (AlivcLivePusher *)  pusher
optional

The callback for resume of stream push from the camera.

Parameters
pusherThe live pusher engine object

◆ onPushStarted:

- (void) onPushStarted: (AlivcLivePusher *)  pusher
optional

The callback for start of stream push.

Parameters
pusherThe live pusher engine object

◆ onPushStatistics:statsInfo:

- (void) onPushStatistics: (AlivcLivePusher *)  pusher
statsInfo: (AlivcLivePushStatsInfo *)  statistics 
optional

The callback for statistics on stream push.

(This callback is invoked every 2 seconds.)

Parameters
pusherThe live pusher engine object
statisticsThe statistics data AlivcLivePushStatsInfo

◆ onPushStoped:

- (void) onPushStoped: (AlivcLivePusher *)  pusher
optional

The callback for end of stream push.

Parameters
pusherThe live pusher engine object

◆ onRemoteUserAudioStream:userId:state:

- (void) onRemoteUserAudioStream: (AlivcLivePusher *)  pusher
userId: (NSString *)  userId
state: (BOOL)  isPushing 
optional

A user opens a audio stream callback in the room Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
userIdUser ID to join the room
isPushingpush state:YES start pushing,NO stop push

◆ onRemoteUserEnterRoom:userId:state:

- (void) onRemoteUserEnterRoom: (AlivcLivePusher *)  pusher
userId: (NSString *)  userId
state: (BOOL)  isOnline 
optional

A user room has been added to the callback Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
userIdUser ID to join the room
isOnlineJoining room status: YES means joining the room, NO means leaving the room
Note
When the anchor and the audience are connected to each other, after the audience starts to push the stream, the anchor can receive the callback. After getting the callback, the anchor can request the userId's streaming address from its business server, using the startPlayWithURL interface of AlivcLivePlayer pull flow

◆ onRemoteUserVideoStream:userId:type:state:

- (void) onRemoteUserVideoStream: (AlivcLivePusher *)  pusher
userId: (NSString *)  userId
type: (AlivcLivePlayVideoStreamType)  videoStreamType
state: (BOOL)  isPushing 
optional

A user opens a camera stream or share screen stream callback in the room, which can be a screen sharing stream or a unity stream Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
userIdUser ID to join the room
videoStreamTypeVideo type, camera stream or screen sharing stream
isPushingpush state:YES start pushing,NO stop push
Note
After the anchor gets the shared stream callback, he can create an AliLivePlayer object, specify the videoStreamType as AlivcLivePlayVideoStreamTypeScreen, use the userId's link address to pull the stream, and use the startPlayWithURL interface of AlivcLivePlayer to pull the stream.

◆ onScreenSharePublishStateChanged:oldState:newState:

- (void) onScreenSharePublishStateChanged: (AlivcLivePusher *)  pusher
oldState: (AliLivePublishState)  oldState
newState: (AliLivePublishState)  newState 
optional

The callback for the screen frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
oldStatePrevious push status,See AliLivePublishState
newStateCurrent push status,See AliLivePublishState

◆ onSetLiveMixTranscodingConfig:status:message:

- (void) onSetLiveMixTranscodingConfig: (AlivcLivePusher *)  pusher
status: (BOOL)  isSuccess
message: (NSString *)  msg 
optional

The callback for mixed-stream transcoding, which corresponds to the setLiveMixTranscodingConfig method Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
isSuccessYES success; NO failure
msgThe error cause

◆ onVideoPublishStateChanged:oldState:newState:

- (void) onVideoPublishStateChanged: (AlivcLivePusher *)  pusher
oldState: (AliLivePublishState)  oldState
newState: (AliLivePublishState)  newState 
optional

The callback for the video frame being sent Note: This callback is available only when livePushMode is set to AlivcLivePushInteractiveMode, that is, when Push SDK is working in interactive mode.

Parameters
pusherThe live pusher engine object
oldStatePrevious push status,See AliLivePublishState
newStateCurrent push status,See AliLivePublishState

The documentation for this protocol was generated from the following file: