Alexa.VideoRecorder接口 (VSK Fire TV)

Alexa.VideoRecorder接口描述了用于以下方面的消息：查找和计划指定视频项目的录制、取消已计划的录制或查询DVR上的剩余录制空间。要录制当前正在播放的内容，请改为实现Alexa.RecordController接口。

有关VideoRecorder接口支持的区域设置列表，请参阅功能接口和支持的区域设置列表。

注意： Alexa.VideoRecorder接口仅适用于云端集成。

指令
属性和事件
- 可报告的属性
- SearchAndRecord.Response
ErrorResponse

指令

该接口的每个指令都包含一个实体对象，该实体对象指定要查找和录制的内容。有关更多信息，请参阅视频内容的实体类型。

SearchAndRecord

根据提供的一组搜索条件，查找并录制指定视频项目的请求。成功处理SearchAndRecord指令后，使用SearchAndRecord.Response事件进行响应。

用户： Alexa, record the new episode of the Grand Tour next week.（Alexa，录制下一周The Grand Tour的新剧集。）

示例： Record the new episode of The Grand Tour next week（录制下一周The Grand Tour的新剧集）

{
    "directive": {
        "endpoint": {
              "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
              },
              "endpointId": "endpoint-001",
              "cookie": {}
            },
        },
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LdjCc8ptlAKulUj90jSqg==",
            "messageId": "708758c5-d1ca-4022-85ba-517f64b07a6c",
            "name": "SearchAndRecord",
            "namespace": "Alexa.VideoRecorder",
            "payloadVersion": "3"
        },
        "payload": {
            "entities": [
                {
                    "externalIds": {
                        "imdb": "tt5712554"
                    },
                    "type": "Video",
                    "value": "The Grand Tour"
                }
            ],
            "quantifier": {
                "name": "NEW"
            },
            "timeWindow": {
                "end": "2017-09-07T23:59:00.00Z",
                "start": "2017-09-01T00:00:00.00Z"
            }
        }
    }
}

有效负载详情

字段	描述	类型	必需
`entities`	与该请求相关的实体对象数组	实体对象数组	是
`quantifier`	录制类型的限定符；是创建新录制，还是录制带有指定标题的项目的下一个或所有出现内容。	对象	否
`quantifier.name`	客户指定的限定符；可能的值为`ALL`、`NEW`、`NEXT`	字符串，请参阅限定符值	否
`timeWindow`	一个时间窗口对象，表示与此请求相关的时间	对象	否
`timeWindow.start`	时间窗口的开始时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否
`timeWindow.end`	时间窗口的结束时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否

其他示例： Record PBS at 5:00 PM（下午5:00录制PBS）

{
    "directive": {
        "endpoint": {
              "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
              },
              "endpointId": "endpoint-001",
              "cookie": {}
            },
        },
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LdjCc8ptlAKulUj90jSqg==",
            "messageId": "1b391648-5346-4bf5-9444-6f14e749b4e3",
            "name": "SearchAndRecord",
            "namespace": "Alexa.VideoRecorder",
            "payloadVersion": "3"
        },
        "payload": {
            "entities": [
                {
                    "entityMetadata": {
                        "channelCallSign": "KBTC",
                        "channelNumber": 123
                    },
                    "externalIds": {
                        "imdb": "tt4574334"
                    },
                    "type": "Channel",
                    "value": "PBS"
                }
            ],
            "timeWindow": {
                "start": "2016-09-01T00:17:00.00Z"
            }
        }
    }
}

CancelRecording

取消指定标题的计划录制的请求。此请求应致使指定的录制（或与请求实体最匹配的标题）被取消。

用户： Alexa, stop recording title.（Alexa，停止录制 [标题]。）

用户： Alexa, cancel recording of next week's episode of The Grand Tour.（Alexa，取消下周The Grand Tour剧集的录制。）

示例： Cancel recording of next week's episode of The Grand Tour（取消下周The Grand Tour剧集的录制）

{
    "directive": {
        "endpoint": {
              "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
              },
              "endpointId": "endpoint-001",
              "cookie": {}
            },
        },
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LdjCc8ptlAKulUj90jSqg==",
            "messageId": "d4a5a7a6-a45a-4e3f-b55a-f583c822384b",
            "name": "CancelRecording",
            "namespace": "Alexa.VideoRecorder",
            "payloadVersion": "3"
        },
        "payload": {
            "entities": [
                {
                    "externalIds": {
                        "imdb": "tt5712554"
                    },
                    "name": "The Grand Tour",
                    "type": "Video"
                }
            ],
            "timeWindow": {
                "end": "2017-09-07T23:59:00+00:00",
                "start": "2017-09-01T00:00:00+00:00"
            }
        }
    }
}

有效负载详情

字段	描述	类型	必需
`entities`	与该请求相关的实体对象数组	实体对象数组	是
`quantifier`	取消请求的限定符；无论是下个项目还是所有项目。	对象	否
`quantifier.name`	限定符的名称，例如客户指定的“下一项”。	字符串，请参阅限定符值	否
`timeWindow`	一个时间窗口对象，表示与此请求相关的时间	对象	否
`timeWindow.start`	时间窗口的开始时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否
`timeWindow.end`	时间窗口的结束时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否

DeleteRecording

删除已录制项目的请求。此请求应致使指定的录制（或与请求实体最匹配的标题）被删除。

用户： Alexa, delete the recording of The Grand Tour.（Alexa，删除The Grand Tour的录制。）

示例： Delete the recording of The Grand Tour（删除The Grand Tour的录制）

{
    "directive": {
        "endpoint": {
              "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
              },
              "endpointId": "endpoint-001",
              "cookie": {}
            },
        },
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LdjCc8ptlAKulUj90jSqg==",
            "messageId": "97b8ce2a-87f6-4c89-9b28-00d716e337ff",
            "name": "DeleteRecording",
            "namespace": "Alexa.VideoRecorder",
            "payloadVersion": "3"
        },
        "payload": {
            "entities": [
                {
                    "externalIds": {
                        "imdb": "tt4574334"
                    },
                    "name": "The Grand Tour",
                    "type": "TV_Show"
                }
            ],
            "quantifier": {
                "name": "ALL"
            },
            "timeWindow": {
                "end": "2016-09-07T23:59:00.00Z",
                "start": "2016-09-01T00:00:00.00Z"
            }
        }
    }
}

有效负载详情

字段	描述	类型	必需
`entities`	与该请求相关的实体对象数组	实体对象数组	是
`quantifier`	删除请求的限定符；是应删除指定标题的全部项目还是只删除已观看的项目。	对象	否
`quantifier.name`	客户指定的限定符的名称。	字符串枚举值，请参阅限定符值	否
`timeWindow`	一个时间窗口对象，表示与此请求相关的时间	对象	否
`timeWindow.start`	时间窗口的开始时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否
`timeWindow.end`	时间窗口的结束时间。	一个使用ISO 8601格式 (YYYY-MM-DDThh:mm:ssZ) 的RFC 3339配置文件的字符串。	否

限定符名称值

下表描述了可能的限定符名称值。

值	描述
`ALL`	与指定实体匹配的所有内容。
`NEXT`	与播放时间最接近指定时间或在指定时间之后最接近的实体匹配的内容。
`NEW`	与指定实体相匹配的首次播出的任何内容。
`WATCHED`	与已观看的实体相匹配的所有内容。

属性和事件

可报告的属性

属性名称	类型	描述
`isExtendedRecordingGUIShown`	布尔值	表示向用户显示的图形用户界面的类型。`true`表示显示了扩展录制图形用户界面；如果未显示扩展录制图形用户界面，则返回`false`。
`storageLevel`	整数	录制设备上使用的存储空间，以百分比表示。

SearchAndRecord.Response

成功处理录制请求后，使用SearchAndRecord.Response事件进行响应。指定消息的有效负载中的录制状态，以及消息上下文中的isExtendedRecordingGUIShown和storageLevel属性值。

示例SearchAndRecord.Response

{
    "context": {
        "properties": [
            {
                "name": "isExtendedRecordingGUIShown",
                "namespace": "Alexa.VideoRecorder",
                "timeOfSample": "2017-05-06T16:20:50.52Z",
                "uncertaintyInMilliseconds": 0,
                "value": false
            },
            {
                "name": "storageLevel",
                "namespace": "Alexa.VideoRecorder",
                "timeOfSample": "2017-05-06T16:20:50.52Z",
                "uncertaintyInMilliseconds": 0,
                "value": 75
            }
        ]
    },
    "event": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LdjCc8ptlAKulUj90jSqg==",
            "messageId": "aa6fd930-ce42-498d-a225-3fb94df83853",
            "name": "Alexa.SearchAndRecordResponse",
            "namespace": "Alexa.VideoRecorder",
            "payloadVersion": "3"
        },
        "payload": {
            "recordingStatus": "SCHEDULED"
        }
    }
}

字段	描述	类型	必需
`recordingStatus`	指示录制状态的字符串枚举值。	字符串为以下值之一： SCHEDULED、STARTED	是

ErrorResponse

如果您由于某种原因无法完成客户请求，则应以错误来回应。有关更多信息，请参阅错误处理文档。

Last updated: 2021年11月11日