主叫方

设置呼叫、挂断推送信息

调用 setPushConfig 方法设置呼叫、挂断推送信息。

提示

主叫端需要在呼叫前调用此方法。

接口

JavaScript

caller.setPushConfig(callPushConfig, hungupPushConfig)

参数说明

参数	类型	必填	说明
callPushConfig	IPushConfig	是	呼叫推送信息
hungupPushConfig	IPushConfig	是	挂断推送信息

示例代码

typescript

/**
 * 设置呼叫、挂断推送数据
 * @param callPushConfig 呼叫推送配置
 * @param callPushConfig.pushTitle 呼叫推送标题
 * @param callPushConfig.pushContent 呼叫推送内容
 * @param hungupPushConfig 挂断推送配置
 * @param hungupPushConfig.pushTitle 挂断推送标题
 * @param hungupPushConfig.pushContent 挂断推送内容
 */
caller.setPushConfig(callPushConfig, hungupPushConfig);

发起呼叫

发起单人通话

完成初始化后，调用 caller.call 方法发起单人音视频通话。

接口

JavaScript

caller.call(params)

参数说明

参数	类型	必填	说明
params	IRCCallParams	是	呼叫参数

params 参数说明

参数	类型	必填	说明
targetId	string	是	对方用户 ID
mediaType	RCCallMediaType	是	通话类型
listener	ISessionListener	是	通话监听器
constraints	{ video?: ICameraVideoProfile, audio?: IMicphoneAudioProfile }	否	用于获取己方媒体资源的参数。ICameraVideoProfile; IMicphoneAudioProfile
extra	string	否	消息的扩展信息
pushTitle	string	否	对方显示通知的标题
pushContent	string	否	对方显示的通知内容

示例代码

typescript

const { code, session } = await caller.call({
    targetId: this.targetId,
    mediaType,
    listener: {
        /**
         * 当远端用户已开始响铃，表示对方已收到呼叫请求（必填）
         * @param sender 已响铃的用户
         * @param session 当前的 session 对象
         */
        onRinging: (sender: ISenderInfo, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 当远端用户同意接听（必填）
         * @param sender 远端用户
         * @param session 当前的 session 对象
         */
        onAccept: (sender: ISenderInfo, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 当有远端用户挂断（必填）
         * @param sender 远端用户
         * @param reason 挂断的原因
         * @param session 当前的 session 对象
         */
        onHungup: (sender: ISenderInfo, reason: RCCallEndReason, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 本端资源或远端资源已获取（必填）
         * @param track 本端资源或远端资源，track 不可设置成 Vue 组件的响应式数据
         * @param session 当前的 session 对象
         */
        onTrackReady: (track: RCTrack, session?: RCCallSession) => {

            // track.isLocalTrack() 是否为本地资源
            // track.isAudioTrack() 是否为音频
            // track.isVideoTrack() 是否为视频
            // track.getUserId() 产生该 track 的用户 ID

            // 播放音频。如果为远端音频，建议直接播放；如为本端音频，建议不播放，以减少回音
            if (track.isAudioTrack() && !track.isLocalTrack()) {
                track.play();
            }

            // 视频在对应的容器里播放
            if (track.isVideoTrack()) {
                const video = document.getElementById(
                    "video" + user.userId
                ) as HTMLVideoElement;
                track.play(video);
            }
        },

        /**
         * 群组通话中有其他人被邀请加入（必填）
         * @param sender 发送者
         * @param invitedUsers 被邀请的用户列表
         * @param session 当前的 session 对象
         */
        onMemberModify: (sender: ISenderInfo, invitedUsers: IInvitedUsers[], session: RCCallSession) => {
        },

        /**
         * 通话类型改变时触发，例如：从视频变成音频通话（必填）
         * @param sender 发送者
         * @param mediaType 1 为音频通话，2 为视频通话
         * @param session 当前的 session 对象
         */
        onMediaModify: (sender: ISenderInfo, mediaType: RCCallMediaType, session: RCCallSession) => {

        },

        /**
         * 对方静音后触发（必填）
         * @param muteUser 已静音的用户
         * @param session 当前的 session 对象
         */
        onAudioMuteChange: (muteUser: IMuteUser, session: RCCallSession) => {
        },

        /**
         * 对方禁用视频后触发（必填）
         * @param muteUser 已禁用视频的用户
         * @param session 当前的 session 对象
         */
        onVideoMuteChange: (muteUser: IMuteUser, session: RCCallSession) => {
        },

    },
});
if (code === RCCallErrorCode.SUCCESS) {
    // do something
}

发起多人通话

完成初始化后，调用 caller.callInGroup 方法发起多人音视频通话。多人通话场景下，所有通话者必须在一个群组内。

接口

JavaScript

caller.callInGroup(params)

参数说明

参数	类型	必填	说明
params	IRCCallInGroupParams	是	群组呼叫参数

示例代码

typescript

const { code, session } = await caller.callInGroup({
    targetId: this.targetId,
    userIds,
    mediaType,
    listener: {

        /**
         * 当远端用户已开始响铃，表示对方已收到呼叫请求（必填）
         * @param sender 已响铃的用户
         * @param session 当前的 session 对象
         */
        onRinging: (sender: ISenderInfo, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 当远端用户同意接听（必填）
         * @param sender 远端用户
         * @param session 当前的 session 对象
         */
        onAccept: (sender: ISenderInfo, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 当有远端用户挂断（必填）
         * @param sender 远端用户
         * @param reason 挂断的原因
         * @param session 当前的 session 对象
         */
        onHungup: (sender: ISenderInfo, reason: RCCallEndReason, session: RCCallSession) => {
            const { userId } = sender;
        },

        /**
         * 本端资源或远端资源已获取（必填）
         * @param track 本端资源或远端资源，track 不可设置成 Vue 组件的响应式数据
         * @param session 当前的 session 对象
         */
        onTrackReady: (track: RCTrack, session?: RCCallSession) => {
            // track.isLocalTrack() 是否为本地资源
            // track.isAudioTrack() 是否为音频
            // track.isVideoTrack() 是否为视频
            // track.getUserId() 产生该 track 的用户 ID

            // 播放音频。如果为远端音频，建议直接播放；如为本端音频，建议不播放，以减少回音
            if (track.isAudioTrack() && !track.isLocalTrack()) {
                track.play();
            }

            // 视频在对应的容器里播放
            if (track.isVideoTrack()) {
                const video = document.getElementById(
                    "video" + user.userId
                ) as HTMLVideoElement;
                track.play(video);
            }
        },

        /**
         * 群组通话中有其他人被邀请加入（必填）
         * @param sender 发送者
         * @param invitedUsers 被邀请的用户列表
         * @param session 当前的 session 对象
         */
        onMemberModify: (sender: ISenderInfo, invitedUsers: IInvitedUsers[], session: RCCallSession) => {
        },

        /**
         * 通话类型改变时触发，例如：从视频变成音频通话（必填）
         * @param sender 发送者
         * @param mediaType 1 为音频通话，2 为视频通话
         * @param session 当前的 session 对象
         */
        onMediaModify: (sender: ISenderInfo, mediaType: RCCallMediaType, session: RCCallSession) => {

        },

        /**
         * 对方静音后触发（必填）
         * @param muteUser 已静音的用户
         * @param session 当前的 session 对象
         */
        onAudioMuteChange: (muteUser: IMuteUser, session: RCCallSession) => {
        },

        /**
         * 对方禁用视频后触发（必填）
         * @param muteUser 已禁用视频的用户
         * @param session 当前的 session 对象
         */
        onVideoMuteChange: (muteUser: IMuteUser, session: RCCallSession) => {
        },

    },
});
if (code === RCCallErrorCode.SUCCESS) {
    // do something
}

挂断通话

调用 session.hungup 方法挂断通话，SDK 内部会自动告知对方挂断、拒绝原因。

接口

JavaScript

session.hungup()

参数说明

无

示例代码

typescript

const { code } = await session.hungup();
// do something

邀请通话

调用 session.invite(userIds) 方法邀请用户加入当前通话（仅限群组）。

接口

JavaScript

session.invite(userIds, options)

参数说明

参数	类型	必填	说明
userIds	Array<string>	是	邀请的用户 ID 列表
options	IInviteOptions	否	邀请参数

IInviteOptions 说明

参数	类型	必填	说明
extra	string	否	邀请的扩展信息
pushConfig	IPushConfig	否	推送配置

示例代码

typescript

const { code } = await session.invite(userIds);
if (code === RCCallErrorCode.SUCCESS) {
    // do something
}