@rongcloud/plugin-wechat-rtc/dist/core/service/interface.d.ts

@rongcloud/plugin-wechat-rtc

import { RTCMode } from '@rongcloud/engine';
import { RCMediaType } from '../enums/RCMediaType';
import { RCRTCCode } from '../enums/RCRTCCode';
import { RCStreamType } from '../enums/RCStreamType';
/**
 * 和 mediaServer 交互时的 requestHeader
 */
export interface IRTCReqHeader {
    /**
      * 开发者的 AppKey
      */
    'App-Key': string;
    /**
      * 用户 Id
      */
    UserId: string;
    /**
     * RTC Token，放房间时 signal 返回
     */
    Token: string;
    /**
      * 房间 Id
      */
    RoomId: string;
    /**
      * 普通音视频模式或直播模式，仅在直播模式下需要
      */
    RoomType?: RTCMode;
}
/**
 * exchange 请求的发布字段
 */
export interface IExchangePub {
    /**
     * 资源 msid，为 userId_tag
     */
    msid: string;
    /**
     * 媒体类型，音频或视频
     */
    mediaType: RCMediaType;
    /**
     * 视频分辨率
     */
    resolution?: string;
}
/**
 * exchange 请求的订阅字段
 */
export interface IExchangeSub {
    /**
     * 资源 URI
     */
    uri: string;
    /**
     * 资源大小流，为空时服务默认为小流
     */
    simulcast?: RCStreamType;
}
/**
 * 发布、订阅的请求体
 */
export interface IExchangeReqBody {
    /**
     * 本地发布的资源列表
     */
    rtmp: IExchangePub[];
    /**
     * 要订阅的资源列表
     */
    subscribeList: IExchangeSub[];
}
/**
 * 发布、订阅响应结构
 */
export interface IExchangeResponse {
    /**
     * 服务返回的状态码
     */
    resultCode: RCRTCCode;
    /**
     * mediaServer 返回的发布资源数据
     */
    publishList: {
        /**
         * 媒体类型
         */
        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
        /**
         * 资源 stream id，userId_tag
         */
        msid: string;
        /**
         * mediaServer 流资源 uri
         * "{\"private_cluster_id\":\"rtc-media-ucbj2-pri.ronghub.com\",\"clusterId\":\"rtc-media-ucbj2.ronghub.com:80\",\"serverId\":\"10.100.100.35:40080\",\"resourceId\":\"11_RongCloudRTC_0\",\"connectionId\":\"AAY2NjM0NjMAAjExAAhtaW5pMDIzNAA=\",\"ssrc\":1200299529,\"serviceProvider\":\"ucloud\",\"userTimestamp\":1650597058583,\"isLiveStream\":false,\"liveType\":0}"
         */
        uri: string;
    }[];
    /**
     * 小程序服务返回的发布资源数据
     * 小程序中发布资源，实际推入 rtmpPublishList - uri 内的 rtmp 地址
     */
    rtmpPublishList: {
        /**
         * 媒体类型
         */
        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
        /**
         * 资源 stream id，userId_tag
         */
        msid: string;
        /**
         * 发布资源推流 rtmp 地址
         * "rtmp://rtc-mini-rtmp-ucbj2.ronghub.com/wechat?token=mGWeZkdJmMgKQgdZuuIs5_Ht2l5OnK4nidcKke568y_rJOFy9-21Ym-2AiV_Ow55-48gdlojo23oQ2ZlbqGhuGL3sGUmgpTk_y1bANUV8Io/hxFsncMZo5IR3a5vvqciNQ"
         */
        uri: string;
    }[];
    /**
     * 小程序服务返回的订阅资源数据
     * 小程序中订阅的资源，实际通过 rtmpSubscribeList - uri 内的 rtmp 地址拉流
     */
    rtmpSubscribeList: {
        /**
         * 媒体类型
         */
        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
        /**
         * 资源 stream id，userId_tag
         */
        msid: string;
        /**
         * 订阅资源的拉流 rtmp 地址
         * "rtmp://rtc-mini-rtmp-ucbj2.ronghub.com/wechat?token=mGWeZkdJmMgKQgdZuuIs5_Ht2l5OnK4nidcKke568y_rJOFy9-21Ym-2AiV_Ow55-48gdlojo23oQ2ZlbqGhuGL3sGUmgpTk_y1bANUV8Io/hxFsncMZo5IR3a5vvqciNQ"
         */
        uri: string;
    }[];
}
//# sourceMappingURL=interface.d.ts.map