title: wilddogVideo

title: wilddogVideo
方法

用于初始化 WilddogVideoCall SDK 和 WilddogVideoRoom SDK。 wilddogVideo.call() 是WilddogVideoCall SDK 的主入口，通过wilddogVideo可以初始化，创建 WilddogVideoCall 实例及创建本地媒体流等操作。

方法

initialize

定义

    wilddogVideo.initialize({'appId':<videoAppId>,'token': <token>});

说明

初始化 wilddogVideoCall。

参数

参数名	描述
appId	在野狗控制面板创建 App 后分配的 Video AppID。
token	通过 `WilddogAuth` 验证登录后获取的 Wilddog ID token。

注意

WilddogVideoCall 对象的使用需要依赖野狗的 Auth，初始化时必须配置 authDomain ，并且 Auth 认证完成后才能获取！

call

定义

    wilddogVideo.call();

说明

创建 WilddogVideoCall实例对象

createLocalStream(options)

定义

createLocalStream

说明

创建本地媒体流。

参数

参数名	说明
captureAudio	`Boolean` 类型。必选参数如果为 `true`，则媒体流中包含声音。如果为 `false`，则媒体流中不包含声音。
captureVideo	`Boolean` 类型。必选参数如果为 `true`，则媒体流中包含视频。如果为 `false`，则媒体流中不包含视频。
dimension	`String` 类型。必选参数只能设置的值以及对应的分辨率如下： `120p` - 160X120 `240p` - 320X240 `360p` - 480X360 `480p` - 640X480 `720p` - 1280X720 `1080p` - 1920X1080
maxFPS	`Number` 类型。可选参数自定义传输视频的最大帧率，默认值为15，最大值为30。
maxBitrateBps	`Number` 类型。可选参数自定义传输视频的最大码率，最大值为2048Kbps。
mixBitrateBps	`Number` 类型。可选参数自定义传输视频的最小码率，最小值为50Kbps。

示例

//创建本地媒体流
wilddogVideo.createLocalStream({
        captureAudio: true,
        captureVideo: true,
        dimension: '480p'
    })
    .then(function(localStream){
        //获取到localStream
    })
    .catch(function(err){
        console.log("Catch error! Error code is " + err);
    })

setToken

定义

    wilddogVideo.setToken(token)

说明

重新设置 token 。

参数

参数名	描述
token	通过 `WilddogAuth` 验证登录后获取的 Wilddog ID token。