Speaker接口提供了对客户端扬声器调整音量以及设置静音的指令与事件。精灵服务支持两种调整音量的方法，其分别由SetVolume与AdjustVolume指令完成。

Speaker上下文

精灵服务要求客户端在每个需要上下文的事件中都要上报volume与muted状态信息。

Sample Message

{
    "header": {
        "namespace": "Speaker",
        "name": "VolumeState"
    },
    "payload": {
        "volume": {{LONG}},
        "muted": {{BOOLEAN}}
    }
}

Payload参数

SetVolume指令

此指令要求客户端以绝对值的方式对音量进行调整。volume参数的值需介于0到100之间 (包含0与100)。

Sample Message

{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "SetVolume",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}}
        }
    }
}

Header参数

Payload参数

AdjustVolume指令

此指令要求客户端以相对值的方式对扬声器音量做调整。volume参数的值需介于 -100 到 100 之间 (包含-100与100)。

AdjustVolume指令所要求的音量调整幅度总是对于目前的音量而言的，volume为正时增加音量，为负时则减少音量。

Sample Message

{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "AdjustVolume",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}}
        }
    }
}

Header参数

Payload参数

VolumeChanged事件

VolumeChanged事件必须在以下状况发生时上报给TVS:

• 当客户端收到 SetVolume 或 AdjustVolume 指令并处理完成时，用以告知其扬声器音量已经调整/改变了。
• 当客户端的音量在本地被直接调整时 (例如用户直接用物理控件改变音量时)，用以告知其扬声器音量已经调整/改变了。
  重要: volume 的值必须在 0与100 之间。如果你的产品原本支持的音量大小是0到10的话，当用户將音量调整为8时，TVS要求将volume为80的事件进行上报。

Sample Message

{
    "event": {
        "header": {
            "namespace": "Speaker",
            "name": "VolumeChanged",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}},
            "muted": {{BOOLEAN}}
        }
    }
}

Header参数

Payload参数

SetMute指令

精灵服务会下发此指令以要求客户端将其产品设置为静音。

Sample Message

{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "SetMute",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "mute": {{BOOLEAN}}
        }
    }
}

Header参数

Payload参数

MuteChanged事件

MuteChanged事件必须在以下状况发生时上报给TVS：

• 当客户端收到 SetMute 指令并处理完成时，用以告知扬声器的静音状态已改变了。
• 当客户端的静音状态在本地被直接调整时 (例如用户直接用物理控件设置静音时)，用以告知其扬声器静音状态已改变了。

Sample Message

{
    "event": {
        "header": {
            "namespace": "Speaker",
            "name": "MuteChanged",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}},
            "muted": {{BOOLEAN}}
        }
    }
}

Header参数

Payload参数

FAQ