AliRTCLinuxEngine接口

获取一个AliRTCEngineInterface实例。

def CreateAliRTCEngine(eventHandler:EngineEventHandlerInterface, lowPort:int, highPort:int, \
                       logPath:str, coreServicePath:str, h5mode:bool, extra:str) -> AliRTCEngineInterface

参数说明

返回说明 AliRTCEngineInterface实例。

销毁AliRTCEngineInterface实例。

def Release() -> None

获取事件回调句柄。

def GetEventHandler() -> EngineEventHandlerInterface

返回说明 事件回调句柄。

语法糖版加入频道，无需传nonce、timestamp，方便客户兼容其他厂商SDK。

def JoinChannel(token:str, channelId:str, userId:str, userName:str, config:JoinChannelConfig) -> int

参数说明

返回说明 0表示方法调用成功，非0表示方法调用失败。

离开频道。

def LeaveChannel() -> int

返回说明 0表示方法调用成功，其他表示方法调用失败。

查询是否允许推送camera track。

def IsLocalVideoStreamPublished() -> bool

返回说明 true表示允许，false表示禁止。

查询是否允许推送screen track。

def IsLocalScreenPublishEnabled() -> bool

返回说明 true表示允许，false表示禁止。

查询是否允许推送audio track。

def IsLocalAudioStreamPublished() -> bool

返回说明 true表示允许，false表示禁止。

查询是否允许推送simulcast (camera track)。

def IsDualStreamPublished() -> bool

返回说明 true表示允许，false表示禁止。

启用外部视频输入源。

def SetExternalVideoSource(enable:bool, sourceType:VideoSource, renderMode:RenderMode) -> int

启用后使用PushExternalVideoFrame接口输入视频数据。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

输入外部输视频, 暂不支持2k及以上的视频输入。

def PushExternalVideoFrame(frame:VideoDataSample, sourceType:VideoSource) -> int

输入视频帧支持多种类型，如YUV和RGB。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败，返回值为ERR_AUDIO_BUFFER_FULL时，可以调整控制发送速率。

设置是否启用外部音频输入推流。

def SetExternalAudioSource(enable:bool, sampleRate:int, channelsPerFrame:int) -> int

可通过SetExternalAudioPublishVolume设置输入音频推流音量。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

输入外部音频数据推流。

def PushExternalAudioFrameRawData(audioSamples:bytes, sampleLength:int, timestamp:int) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败，返回值为ERR_AUDIO_BUFFER_FULL时，需要在间隔投递数据时间长度后再次重试投递。

设置音质。

def SetAudioProfile(audioProfile:AudioQualityMode, audioScene:AudioSceneMode) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

设置外部输入音频推流混音音量。

def SetExternalAudioPublishVolume(volume:int) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

获取外部输入音频推流混音音量。

def GetExternalAudioPublishVolume() -> int

返回说明 音量。

发送媒体扩展信息(SEI)， 最大长度为4*1024字节，用于业务的少量数据传输。

def SendMediaExtensionMsg(message:bytes, length:int, repeatCount:int, delay:int, isKeyFrame:bool) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

是否允许推送次要视频流。

def PublishLocalDualStream(enabled:bool) -> int

次要视频流只在推送视频流的前提下才会推送，设置推送次要视频流时，请确认已通过PublishLocalVideoStream方法开启视频流推送。 SDK默认设置不推送次要视频流，在加入频道前也可以调用此接口修改默认值，并在推送视频流时生效。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

是否推送本地视频（摄像头）流。

def PublishLocalVideoStream(enabled:bool) -> int

SDK默认设置推送视频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

是否推送本地音频流。

def PublishLocalAudioStream(enabled:bool) -> int

SDK默认设置推送音频流，在加入频道前也可以调用此接口修改默认值，并在加入频道成功时生效

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

开始推送屏幕流。

def PublishScreenShareStream(enabled:bool) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

停止/恢复订阅特定远端用户的音频流, 用于会中调用, 会前调用无效。

def SubscribeRemoteAudioStream(uid:str, sub:bool) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

停止/恢复订阅远端用户的视频流, 用于会中调用, 会前调用无效。

def SubscribeRemoteVideoStream(uid:str, videoTrack:VideoTrack, sub:bool) -> int:

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

设置相机流视频编码属性。

def SetVideoEncoderConfiguration(config:AliEngineVideoEncoderConfiguration) -> int

该方法用于设置相机流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等。所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。 该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次相机流视频编码属性，建议在入会前调用。

参数说明

设置屏幕流视频编码属性。

def SetScreenShareEncoderConfiguration(config:AliEngineScreenShareEncoderConfiguration) -> int

该方法用于设置屏幕流视频编码属性对应的视频参数，如分辨率、帧率、码率、视频方向等。所有设置的参数都有相应的范围限制，如果设置的参数不在有效范围内，SDK会自动调节。 该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次屏幕流视频编码属性，建议在入会前调用。

参数说明

设置订阅相机流格式，大流或小流。

def SetRemoteVideoStreamType(uid:str, streamType:AliEngineVideoStreamType) -> int;

推流端当前默认不推送小流，只有发送端调用了 PublishLocalDualStream(true) 打开双流模式，接收端才可以选择订阅大流还是小流，否则订阅的只能是大流。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

停止或恢复本地视频数据发送。

def MuteLocalCamera(mute:bool) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

停止或恢复本地音频数据发送。

def MuteLocalMic(mute:bool) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

设置用户角色。

def SetClientRole(clientRole:AliEngineClientRole) -> int

只可以在频道模式为AliRtcChannelProfileCommunication下调用，入会前/会议中均可设置，设置成功会收到OnUpdateRoleNotify。 从Interactive转换为Live角色需要先停止推流，否则返回失败。 频道模式为AliRtcChannelProfileInteractiveLive模式时，用户角色默认为AliRtcClientRoleLive。

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

设置默认订阅视频流类型。

def SetRemoteDefaultVideoStreamType(streamType:AliEngineVideoStreamType) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

以观众模式入会后，若房间内的所有主播均下播，就立即回调OnError，错误码ERR_NO_PEOPLE。

def LeaveOnceNoStreamer(enable:bool) -> None

此功能为审核场景定制能力。

参数说明

入会后等待一段时间，若始终无人上线则回调OnError，错误码ERR_NO_PEOPLE。

def SetPeriodForCheckPeople(seconds:int) -> None

同时入会失败，体现为OnJoinChannelResult回调值-1。 此功能为审核场景定制能力，默认检查空房间的最大时长为5秒。

参数说明

JSON格式字符串进行自定义配置，如打开关闭dataChannel。

def SetParameter(params:str) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

在本地生成JoinChannel所需要的token，绕过appserver完成鉴权。

def GenerateToken(authInfo:AuthInfo, appkey:str) -> None

方法内生成单参数入会token。

参数说明

通过dataChannel发送数据。

def SendDataChannelMessage(ctrlMsg:AliEngineDataChannelMsg) -> int

参数说明

返回说明 0表示方法调用成功，其他表示方法调用失败。

如果engine出现error，通过这个消息通知业务层。

def OnError(self, error_code:ERROR_CODE) -> None

参数说明

如果engine出现warning，通过这个消息通知业务层。

def OnWarning(self, warning_code:WARNNING_CODE) -> None

参数说明

加入频道结果。

def OnJoinChannelResult(self, result:int, channel:str, userId:str) -> None

当应用调用 JoinChannel方法时，该回调表示成功/失败加入频道。

参数说明

获得dataChannel远端数据。

def OnDataChannelMsg(self, uid:str, msg:AliEngineDataChannelMsg) -> None

参数说明

离开频道结果。

def OnLeaveChannelResult(self, result:int) -> None

应用调用 LeaveChannel方法时，该回调表示成功/失败离开频道，回调将会返回离会的result,如果 LeaveChannel 后直接 Destory SDK，将不会收到此回调。

参数说明

远端用户（通信模式）/（互动模式，主播角色）加入频道回调。

def OnRemoteUserOnLineNotify(self, uid:str) -> None

该回调在以下场景会被触发：

互动模式下回调行为：

1. 主播间可以互相收到加入频道回调。

2. 观众可以收到主播加入频道回调。

3. 主播无法收到观众加入频道回调。

参数说明

远端用户（通信模式）/（互动模式，主播角色）离开频道回调。

def OnRemoteUserOffLineNotify(self, uid:str) -> None

该回调在以下场景会被触发：

通信模式和互动模式主播角色情况下，当长时间收不到远端用户数据，超时掉线时，会触发该回调。

参数说明

远端用户的音视频流发生变化回调。

def OnRemoteTrackAvailableNotify(self, uid:str, audioTrack:AudioTrack, videoTrack:VideoTrack) -> None

该回调在以下场景会被触发：

1. 当远端用户从未推流变更为推流（包括音频和视频）。

2. 当远端用户从已推流变更为未推流（包括音频和视频）。

3. 互动模式下，调用SetClientRole切换为主播角色 AliEngineClientRoleInteractive，同时设置了推流时，会触发该回调。

该回调仅在通信模式用户和互动模式下的主播角色才会触发。

参数说明

音频订阅情况变更回调。

def OnAudioSubscribeStateChanged(self, uid:str, oldState:AliEngineSubscribeState, newState:AliEngineSubscribeState,
                                     elapseSinceLastState:int, channel:str) -> None

参数说明

相机流订阅情况变更回调。

def OnVideoSubscribeStateChanged(self, uid:str, oldState:AliEngineSubscribeState, newState:AliEngineSubscribeState,
                                     elapseSinceLastState:int, channel:str) -> None

参数说明

大小订阅情况变更回调。

def OnSubscribeStreamTypeChanged(self, uid:str, oldStreamType:AliEngineVideoStreamType, newStreamType:AliEngineVideoStreamType,
                                     elapseSinceLastState:int, channel:str) -> None

参数说明

屏幕分享流订阅情况变更回调。

def OnScreenShareSubscribeStateChanged(self, uid:str, oldState:AliEngineSubscribeState, newState:AliEngineSubscribeState,
                                           elapseSinceLastState:int, channel:str) -> None

参数说明

屏幕分享推流变更回调。

def OnScreenSharePublishStateChanged(self, oldState:AliEnginePublishState, newState:AliEnginePublishState,
                                         elapseSinceLastState:int, channel:str) -> None

参数说明

次要流推流变更回调。

def OnDualStreamPublishStateChanged(self, oldState:AliEnginePublishState, newState:AliEnginePublishState,
                                        elapseSinceLastState:int, channel:str) -> None

参数说明

视频推流变更回调。

def OnVideoPublishStateChanged(self, oldState:AliEnginePublishState, newState:AliEnginePublishState,
                                   elapseSinceLastState:int, channel:str) -> None

参数说明

音频推流变更回调。

def OnAudioPublishStateChanged(self, oldState:AliEnginePublishState, newState:AliEnginePublishState,
                                   elapseSinceLastState:int, channel:str) -> None

参数说明

混音前每一路远端用户的音频数据回调。

def OnSubscribeAudioFrame(self, uid:str, frame:AudioFrame) -> None

来自远端单个用户的音频数据，详见 AliRTCSdk::Linux::AudioFormatPcmBeforMixing。

参数说明

本地订阅音频数据回调。

def OnSubscribeMixAudioFrame(self, frame:AudioFrame) -> None

远端所有用户混音后待播放的音频数据，详见 AudioFrame: 音频帧类。

参数说明

订阅的远端视频数据回调。

def OnRemoteVideoSample(self, uid:str, frame:VideoFrame) -> None

参数说明

订阅的远端视频，解码前数据回调。

def OnRemoteVideoEncodedSample(self, uid:str, frame:VideoFrame) -> None

参数说明

收到媒体扩展信息回调。

def OnMediaExtensionMsgReceived(self, userid:str, message:bytes, size:int) -> None

当一端通过SendMediaExtensionMsg发送信息后，其他端通过该回调接收数据。

参数说明

当用户角色发生变化时通知。

def OnUpdateRoleNotify(self, oldRole:AliEngineClientRole, newRole:AliEngineClientRole) -> None

调用SetClientRole方法切换角色成功时触发此回调。

参数说明

音频存档定制能力，分流音频转码AAC输出。

def OnSubscribeAudioAac(self, uid:str, frame:AudioFrame) -> None

参数说明

音频存档定制能力，合流音频转码AAC输出。

def OnSubscribeMixedAudioAac(self, frame:AudioFrame) -> None

参数说明

非匀速情况下推送音频数据过快，SDK反馈状态。

def OnPushAudioFrameBufferFull(self, isFull:bool) -> None

参数说明

非匀速情况下推送视频数据过快，SDK反馈状态。

def OnPushVideoFrameBufferFull(self, isFull:bool) -> None

参数说明