直播过程控制

本章节介绍互动直播过程中网易云提供的各种控制功能。包括互动直播控制通用控制互动直播控制包括改变自己在会议中的角色(互动者/观众)、互动直播过程中切换推流地址 通用控制包括是否接收某用户的音频或视频数据等

重连接口

API介绍

在通话过程中,主动重连通话。在通话过程中有效

API原型

参数说明

参数 类型 说明
json_extension string Json string 扩展,kNIMVChatSessionId
cb function 回调函数
user_data(C) void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!

返回值说明

调用结果返回见回调函数,连接结果监听connect回调

示例

改变自己在会议中的角色

API介绍

设置观众模式(多人模式下),全局有效(重新发起时也生效),观众模式能减少运行开销。

获取当前是否是观众模式。

API原型

参数说明

参数 类型 所在函数 说明
viewer bool SetViewerMode(C/C#)
nim_vchat_set_viewer_mode(C)
是否设为观众模式。

返回值说明

Set函数无返回值。

Get函数返回当前是否为观众模式。

示例

指定某用户设置是否接收其音视频数据

API介绍

设置单个成员的音频黑名单或视频黑名单状态,使得自己能接收或不接收其音频数据或视频数据。当前通话有效(只能设置进入过房间的成员)。

API原型

参数说明

参数 类型 说明
uid string 对方账号。
add bool true表示添加到黑名单,false表示从黑名单移除。
audio bool true表示音频黑名单,false表示视频黑名单。
json_extension string 无效扩展字段。
cb function 结果回调,见nim_vchat_def.h,返回的json_extension无效。
user_data(C) void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!

返回值说明

无返回值。

示例

将自己静音

API介绍

将自己静音:设置是否发送本地音频流数据。全局有效,重新发起会话时也生效。此开关打开音频只发静音包。

获取音频静音状态。

API原型

参数说明

参数 类型 所在函数 说明
muted bool SetAudioMuted(C/C#)
nim_vchat_set_audio_mute(C)
true静音,false不静音。

返回值说明

设置静音接口无返回值。

获取静音状态接口返回静音状态。

示例

静音所有远端音频

API介绍

静音所有远端音频:设置是否播放所有远端用户的音频流数据。全局有效,重新发起会话时也生效。此开关打开音频只发静音包。只针对sdk中播放远端声音静音,不影像数据接收和录制功能。

获取音频播放静音状态。

API原型

参数说明

参数 类型 说明
muted bool true静音,false不静音。

返回值说明

设置静音接口无返回值。

获取静音状态接口返回静音状态。

示例

切换通话模式

API介绍

设置通话模式,在更改通话模式后,通知底层。

API原型

参数说明

参数 类型 说明
mode enum 音视频通话类型,见NIMVideoChatMode。
json_extension(C/C++) string 无效的扩展字段。

返回值说明

调用成功返回true,调用失败返回false。

示例

互动直播过程中切换推流地址

API介绍

通话中修改直播推流地址(主播有效)。

API原型

参数说明

参数 类型 说明
rtmp_url string 新的rtmp推流地址
json_extension(C/C#) string 无效扩展字段
cb function 结果回调,见nim_vchat_def.h,返回的json_extension无效。
user_data(C) void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!

返回值说明

无返回值。

示例

通用控制

指定某用户设置是否接收其音视频数据

API介绍

设置单个成员的音频黑名单或视频黑名单状态,使得自己能接收或不接收其音频数据或视频数据。当前通话有效(只能设置进入过房间的成员)。 当设置对方音频黑名单时,即静音指定用户音频:设置是否播放某个远端用户的音频流数据。

API原型

参数说明

参数 类型 说明
uid string 对方账号。
add bool true表示添加到黑名单,false表示从黑名单移除。
audio bool true表示音频黑名单,false表示视频黑名单。
json_extension string 无效扩展字段。
cb function 结果回调,见nim_vchat_def.h,返回的json_extension无效。
user_data(C) void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!

返回值说明

无返回值。

示例

自动旋转对方画面

API介绍

设置不自动旋转对方画面,默认打开,全局有效(重新发起时也生效)。

获取自动旋转对方画面设置状态。

API原型

参数说明

参数 类型 所在函数 说明
rotate bool SetRotateRemoteVideo(C++/C#)
nim_vchat_set_rotate_remote_video(C)
true自动旋转,false不自动旋转。

返回值说明

设置接口无返回值。

获取接口返回true表示自动旋转对方画面,false表示不自动旋转对方画面。

示例

互动直播主画面切换

API介绍

设置uid的用户画面为主画面,需要主播权限

API原型

参数说明

参数 类型 说明
uid string 需要设置的主画面账号。
json_extension string 无效扩展字段。
cb function 结果回调,见nim_vchat_def.h,返回的json_extension无效。
user_data(C) void* APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理!

返回值说明

设置接口无返回值。

获取接口返回true表示自动旋转对方画面,false表示不自动旋转对方画面。

示例