wildfire-im-sdk/lib/wfc/av/engine/avenginekit.d.ts

野火IM SDK for Vue3 projects

export default class WfcAVEngineKit {
    static MAX_AUDIO_PARTICIPANT_COUNT: number;
    static MAX_VIDEO_PARTICIPANT_COUNT: number;
    static DISABLE_DUAL_STREAM: boolean;
    /**
     屏幕分享替换模式。为ture时，屏幕分享会替换摄像头的数据流。为false时，屏幕分享会再单独发起一路，不会影响摄像头的输入。
     */
    static SCREEN_SHARING_REPLACE_MODE: boolean;
    /**
     * 是否启用 datachannel
     * @type {boolean}
     */
    static ENABLE_DATA_CHANNEL: boolean;
    /**
     禁止双流模式下，小流低帧率。默认为false，小流的帧率为8fps。当为true时使用 {@link SMALL_STREAM_FPS}， 或者使用同大流一样的帧率
     */
    static DISABLE_SMALL_STREAM_LOW_FPS: boolean;
    /**
     * 小流分辨率，宽度
     */
    static SMALL_STREAM_WIDTH: number;
    /**
     * 小流分辨率， 高度
     */
    static SMALL_STREAM_HEIGHT: number;
    /**
     * 小流 fps
     */
    static SMALL_STREAM_FPS: number;
    static VIDEO_PROFILE: number;
    static SCREEN_SHARE_MAX_BITRATE: number;
    /**
     * 高级版音视频 SDK 有效
     * 是否强制使用 TCP 传输媒体数据
     * 启用时，janus 的配置里面，需要将 ice_tcp 置为 true
     * 注意，强制使用 TCP 传输媒体数据，在网络丢包比较严重时，效果可能不太好
     * @type {boolean}
     */
    static FORCE_MEDIA_OVER_TCP: boolean;
    /**
     * 没有麦克风和音频输出设备时，是否允许发起或参加音视频通话
     * @type {boolean}
     */
    static ENABLE_VOIP_WHEN_NO_MIC_AND_SPEAKER: boolean;
    /**
     * 高级版音视频 SDK 有效
     * 是否强制采用 relay 模式
     * 具体请参考 {@link https://docs.wildfirechat.cn/blogs/%E9%9F%B3%E8%A7%86%E9%A2%91%E9%AB%98%E7%BA%A7%E7%89%88%E7%9A%84%E5%8D%95%E7%AB%AF%E5%8F%A3%E5%8C%96%E5%92%8C%E5%BC%BA%E5%88%B6TCP%E5%8C%96.html}
     * @type {boolean}
     */
    static FORCE_RELAY: boolean;
    static DUMMY_VIDEO_URI: string;
    /**
     * CallSession 相关回调
     * @deprecated 可能被移除，请勿直接设置，可通过{@link setup}参数直接传入
     */
    sessionCallback: any;
    /**
     * 音视频window显示的时候调用
     */
    setup(sessionCallback: any): void;
    /**
     * 返回当前音视频通话session
     * 仅在音视频窗口调用有效
     */
    getCurrentSession(): void;
}