前端组件开发文档

微吼组件开发及使用规范


媒体设置

<p>[TOC]</p> <h4>示例</h4> <pre><code class="language-html">&lt;device-setting ref="deviceSetting" :sdkInstance="sdkInstance" :roomId="roomInfo.room_id" &gt;&lt;/device-setting&gt;</code></pre> <h4>props</h4> <table> <thead> <tr> <th style="text-align: left;">参数</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">可选值</th> <th style="text-align: left;">默认值</th> <th style="text-align: left;">必填</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sdkInstance</td> <td style="text-align: left;">互动 SDK 实例</td> <td style="text-align: left;">object</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td style="text-align: left;">是</td> </tr> <tr> <td style="text-align: left;">accountId</td> <td style="text-align: left;">用户 ID</td> <td style="text-align: left;">string</td> <td style="text-align: left;">-</td> <td style="text-align: left;"></td> <td style="text-align: left;">是</td> </tr> <tr> <td style="text-align: left;">roomId</td> <td style="text-align: left;">房间 ID</td> <td style="text-align: left;">string</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td style="text-align: left;">是</td> </tr> <tr> <td style="text-align: left;">openAudio</td> <td style="text-align: left;">是否显示勾选音频直播复选框</td> <td style="text-align: left;">boolean</td> <td style="text-align: left;">-</td> <td style="text-align: left;">false</td> <td style="text-align: left;">&nbsp;</td> </tr> <tr> <td style="text-align: left;">openDeviceCheck</td> <td style="text-align: left;">保存设备后是否调保存设备信息的接口</td> <td style="text-align: left;">boolean</td> <td style="text-align: left;"></td> <td style="text-align: left;">true</td> <td style="text-align: left;">&nbsp;</td> </tr> <tr> <td style="text-align: left;">openRate</td> <td style="text-align: left;">是否显示分辨率选项并获取视频设备的分辨率</td> <td style="text-align: left;">boolean</td> <td style="text-align: left;"></td> <td style="text-align: left;">true</td> <td style="text-align: left;">&nbsp;</td> </tr> </tbody> </table> <h4>openAudio</h4> <p>默认情况下,获取到设备信息后,会把音频和视频设备 ID 存在 session 中,推流时如果没有传入推流参数,默认会使用 session 中设备 ID。勾选音频直播模式时,session 中不会存视频设备 ID,推流时不会采集视频流。</p> <h4>openDeviceCheck</h4> <p>默认情况下,获取到设备信息后并保存后,会调 vss 接口保存设备信息,其他用户会收到该用户的设备检测消息,用以判断该用户的设备是否正常。</p> <hr /> <h4>methods</h4> <table> <thead> <tr> <th style="text-align: left;">方法名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">参数</th> <th style="text-align: left;">返回值</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">etDeviceInfo</td> <td style="text-align: left;">获取设备信息,返回 Promise</td> <td style="text-align: left;">-</td> <td style="text-align: left;">{ videoDevices:Array,audioDevices:Array }</td> </tr> <tr> <td style="text-align: left;">startPreview</td> <td style="text-align: left;">创建预览,返回 Promise</td> <td style="text-align: left;">object,可以覆盖默认创建预览参数</td> <td style="text-align: left;">-</td> </tr> <tr> <td style="text-align: left;">stopPreview</td> <td style="text-align: left;">停止预览,返回 Promise</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> </tr> </tbody> </table> <h4>events</h4> <table> <thead> <tr> <th style="text-align: left;">事件名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">回调参数</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">component_device_change</td> <td style="text-align: left;">设备变更</td> <td style="text-align: left;">{videoId,audioId,rate,isAudio}</td> </tr> </tbody> </table>

页面列表

ITEM_HTML