Kakao i Agent::Service Agent Interface::PlaybackController

페이지 이동경로

PlaybackController

PlaybackController 인터페이스는 음성 요청이 아닌 하드웨어 또는 소프트웨어(GUI) 상의 버튼을 사용하여 재생 대기열을 탐색하기 위한 일련의 Event를 제공합니다.

PlaybackController 인터페이스
Message 인터페이스 설명
Event PlayCommanded 사용자가 미디어 항목의 재생을 시작 또는 재개 시 전송
PauseCommanded 사용자가 미디어 항목의 재생을 일시 중지할 때 전송
NextCommanded 사용자가 재생 대기열의 다음 미디어 항목으로 건너뛸 때 전송
PreviousCommanded 사용자가 재생 대기열의 이전 미디어 항목으로 건너뛸 때 전송
StopCommanded 사용자가 미디어 항목의 재생을 정지할 때 KVS에 전송
ResumeCommanded 사용자가 일시 중지된 미디어 항목의 재생을 재개할 때 전송

Event

Event Message의 호출 방식은 다음과 같습니다.

Event Message 호출 방식
메서드 요청 URL
POST /{{API version}}/events

PlayCommanded

PlaybackController.PlayCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 미디어 항목의 재생을 시작 또는 재개 시, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.PlayCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.PlayCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}
}

Request Header

PlaybackController.PlayCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.PlayCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요

PauseCommanded

PlaybackController.PauseCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 미디어 항목의 재생을 일시 중지할 때, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.PauseCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.PauseCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}
}

Request Header

PlaybackController.PauseCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.PauseCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요

NextCommanded

PlaybackController.NextCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 재생 대기열의 미디어 항목으로 건너뛸 때, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.NextCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.NextCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}
}

Request Header

PlaybackController.NextCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.NextCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요

PreviousCommanded

PlaybackController.PreviousCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 재생 대기열의 이전 미디어 항목으로 건너뛸 때, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.PreviousCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.PreviousCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}

Request Header

PlaybackController.PreviousCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.PreviousCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요

StopCommanded

PlaybackController.StopCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 미디어 항목의 재생을 정지할 때, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.StopCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.ResumeCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}
}

Request Header

PlaybackController.StopCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.StopCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요

ResumeCommanded

PlaybackController.ResumeCommanded는 사용자가 음성 요청이 아닌 하드웨어 또는 소프트웨어 버튼을 사용하여 일시 중지된 미디어 항목의 재생을 재개할 때, Service Agent에서 KVS로 전송하는 Event입니다.

Request Syntax

코드예제PlaybackController.ResumeCommanded Request Syntax
{
	"event": {
		"header": {
			"type": "PlaybackController.ResumeCommanded",
			"messageId": "{{STRING}}",
		},
		"body": {
			"handled": {{BOOLEAN}}
		}
	}
}

Request Header

PlaybackController.ResumeCommanded Request Header
파라미터 타입 필수 여부 설명
type String 필수 해당 인터페이스 이름
messageId String 필수 특정 메시지를 나타내는 고유 ID
- 해당 메시지의 생성 주체가 임의의 UUID로 정의

Request Body

PlaybackController.ResumeCommanded Request Body
파라미터 타입 필수 여부 설명
handled Boolean 필수 스피커의 버튼 동작 처리 여부
true: Service Agent에서 처리했으나 서버에서 무시
false: Service Agent에서 미처리하여 서버에서 처리 필요
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.