네임스페이스: Cast

chrome.전송

네임스페이스   정적

chrome.cast 네임스페이스입니다.

클래스

ApiConfig

초기화될 때 API의 구성을 보유합니다.

CredentialsData

발신자의 사용자 인증 정보를 식별하는 데 사용되는 사용자 인증 정보 데이터입니다.

DialRequest

DIAL 앱 시작 요청입니다.

오류

API에서 반환된 오류를 설명합니다. 일반적으로 이러한 객체는 클라이언트가 만들면 안 됩니다.

이미지

수신기 애플리케이션 또는 미디어 항목을 설명하는 이미지입니다. 애플리케이션 아이콘, 커버 이미지, 썸네일 등이 될 수 있습니다.

수신자

애플리케이션을 실행하는 수신기를 설명합니다. 일반적으로 이러한 객체는 클라이언트가 만들면 안 됩니다.

ReceiverDisplayStatus

확장 프로그램 UI에서 사용자에게 표시되는 수신기 상태입니다. CUSTOM 수신기에만 유효합니다.

SenderApplication

발신기 애플리케이션을 설명합니다. 일반적으로 이러한 객체는 클라이언트가 만들면 안 됩니다.

세션

현재 실행 중인 Cast 애플리케이션의 상태를 설명합니다. 일반적으로 이러한 객체는 클라이언트가 만들면 안 됩니다.

SessionRequest

세션 시작 또는 연결 요청입니다.

제한 시간

API 메서드의 기본 제한 시간 값을 밀리초 단위로 정의합니다.

볼륨

기기 또는 미디어 스트림의 볼륨입니다.

네임스페이스

media

열거형

AutoJoinPolicy

정적

string

자동 조인 정책은 API 초기화 후 SDK가 발신자 애플리케이션을 기존 세션에 자동으로 연결하는 시점을 결정합니다.

값
TAB_AND_ORIGIN_SCOPED	string 세션이 동일한 탭 및 페이지 출처에서 동일한 appId로 시작되면 자동으로 연결됩니다.
ORIGIN_SCOPED	string 세션이 동일한 appId 및 동일한 페이지 출처로 시작되면 자동으로 연결됩니다 (탭과 무관함).
PAGE_SCOPED	string 자동 연결이 없습니다.

기능

정적

string

수신 기기에서 지원하는 기능

값
VIDEO_OUT	string 수신기는 동영상 출력을 지원합니다.
AUDIO_OUT	string 수신기는 오디오 출력을 지원합니다.
VIDEO_IN	string 수신기가 동영상 입력 (카메라)을 지원합니다.
AUDIO_IN	string 수신기가 오디오 입력 (마이크)을 지원합니다.
MULTIZONE_GROUP	string 수신기는 다중 영역 그룹을 나타냅니다.

DefaultActionPolicy

정적

string

기본 작업 정책은 API를 초기화한 후 SDK가 자동으로 세션을 만드는 시점을 결정합니다. 이는 확장 프로그램 팝업에 표시되는 탭의 기본 작업도 제어합니다.

값
CREATE_SESSION	string API가 초기화될 때 앱이 포함된 탭이 전송되면 SDK가 탭 전송을 중지하고 자동으로 앱을 시작합니다. 확장 프로그램 팝업에서 사용자에게 앱을 전송하라는 메시지를 표시합니다.
CAST_THIS_TAB	string 탭이 전송 중이더라도 API 초기화 후에는 자동 실행이 실행되지 않습니다. 확장 프로그램 팝업에서 사용자에게 탭을 전송하라는 메시지를 표시합니다.

DialAppState

정적

string

DIAL 애플리케이션의 가능한 상태입니다.

값
실행 중	string
STOPPED	string
오류	string 사양의 일부가 아니며 오류를 알리는 데 사용됩니다.

ErrorCode

정적

string

SDK에서 반환할 수 있는 오류입니다.

값
취소	string 사용자가 작업을 취소했습니다.
TIMEOUT	string 작업 시간이 초과되었습니다.
API_NOT_INITIALIZED	string API가 초기화되지 않았습니다.
INVALID_PARAMETER	string 작업에 대한 매개변수가 잘못되었습니다.
EXTENSION_NOT_COMPATIBLE	string API 스크립트가 설치된 Cast 확장 프로그램과 호환되지 않습니다.
EXTENSION_MISSING	string Cast 확장 프로그램을 사용할 수 없습니다.
RECEIVER_UNAVAILABLE	string 세션 요청과 호환되는 수신기가 없습니다.
SESSION_ERROR	string 세션을 생성할 수 없거나 세션이 잘못되었습니다.
CHANNEL_ERROR	string 받는 사람의 채널을 사용할 수 없습니다.
LOAD_MEDIA_FAILED	string 미디어를 로드하지 못했습니다.

ReceiverAction

정적

string

사용자가 확장 프로그램의 수신기에 관해 실행할 수 있는 작업입니다. 전송 작업이 완전히 완료되거나 실패하기 전에 발신자 애플리케이션 UI에서 전환을 표시하는 데 사용할 수 있습니다.

값
CAST	string 사용자가 발신기 애플리케이션을 통해 전송하려는 의도로 수신기를 선택했습니다. 수신자의 정확한 ID는 알 수 없습니다.
중지	string 사용자가 수신기에서 실행 중인 세션 중지를 요청했습니다.

ReceiverAvailability

정적

string

Cast 수신기의 사용 가능 여부를 설명합니다.

값
통화 가능	string 세션 요청과 호환되는 수신기를 하나 이상 사용할 수 있습니다.
UNAVAILABLE	string 사용할 수 있는 수신기가 없습니다.

ReceiverType

정적

string

값
CAST	string 캐스트 수신기(예: Chromecast)
DIAL	string 다이얼 기기(예: 스마트 TV)
행아웃	string 행아웃
커스텀	string 고객이 제공한 맞춤 수신자

SenderPlatform

정적

string

발신기 애플리케이션 플랫폼을 설명합니다.

값
Chrome	string
iOS	string
ANDROID	string

SessionStatus

정적

string

수신기 애플리케이션에 Cast 세션의 상태를 설명합니다.

값
연결	string 세션이 수신 애플리케이션에 연결됩니다.
연결 끊김	string 세션과 수신 애플리케이션의 연결이 끊어집니다. 수신자 애플리케이션은 아직 실행 중일 수도 있고 실행되지 않을 수도 있습니다.
STOPPED	string 수신기 애플리케이션이 중지되었습니다.

VolumeControlType

정적

string

볼륨 제어 유형을 설명합니다.

값
관심 유도	string Cast 기기의 볼륨을 변경할 수 있습니다.
해결됨	string Cast 기기의 볼륨이 고정되어 있으며 변경할 수 없습니다.
마스터	string 마스터 시스템 볼륨 컨트롤(예: TV 또는 오디오 기기 볼륨이 변경됨)을 제어합니다.

속성

AutoJoinPolicy

정적

string

자동 조인 정책은 API 초기화 후 SDK가 발신자 애플리케이션을 기존 세션에 자동으로 연결하는 시점을 결정합니다.

값
TAB_AND_ORIGIN_SCOPED	string 세션이 동일한 탭 및 페이지 출처에서 동일한 appId로 시작되면 자동으로 연결됩니다.
ORIGIN_SCOPED	string 세션이 동일한 appId 및 동일한 페이지 출처로 시작되면 자동으로 연결됩니다 (탭과 무관함).
PAGE_SCOPED	string 자동 연결이 없습니다.

기능

정적

string

수신 기기에서 지원하는 기능

값
VIDEO_OUT	string 수신기는 동영상 출력을 지원합니다.
AUDIO_OUT	string 수신기는 오디오 출력을 지원합니다.
VIDEO_IN	string 수신기가 동영상 입력 (카메라)을 지원합니다.
AUDIO_IN	string 수신기가 오디오 입력 (마이크)을 지원합니다.
MULTIZONE_GROUP	string 수신기는 다중 영역 그룹을 나타냅니다.

DefaultActionPolicy

정적

string

기본 작업 정책은 API를 초기화한 후 SDK가 자동으로 세션을 만드는 시점을 결정합니다. 이는 확장 프로그램 팝업에 표시되는 탭의 기본 작업도 제어합니다.

값
CREATE_SESSION	string API가 초기화될 때 앱이 포함된 탭이 전송되면 SDK가 탭 전송을 중지하고 자동으로 앱을 시작합니다. 확장 프로그램 팝업에서 사용자에게 앱을 전송하라는 메시지를 표시합니다.
CAST_THIS_TAB	string 탭이 전송 중이더라도 API 초기화 후에는 자동 실행이 실행되지 않습니다. 확장 프로그램 팝업에서 사용자에게 탭을 전송하라는 메시지를 표시합니다.

DialAppState

정적

string

DIAL 애플리케이션의 가능한 상태입니다.

값
실행 중	string
STOPPED	string
오류	string 사양의 일부가 아니며 오류를 알리는 데 사용됩니다.

ErrorCode

정적

string

SDK에서 반환할 수 있는 오류입니다.

값
취소	string 사용자가 작업을 취소했습니다.
TIMEOUT	string 작업 시간이 초과되었습니다.
API_NOT_INITIALIZED	string API가 초기화되지 않았습니다.
INVALID_PARAMETER	string 작업에 대한 매개변수가 잘못되었습니다.
EXTENSION_NOT_COMPATIBLE	string API 스크립트가 설치된 Cast 확장 프로그램과 호환되지 않습니다.
EXTENSION_MISSING	string Cast 확장 프로그램을 사용할 수 없습니다.
RECEIVER_UNAVAILABLE	string 세션 요청과 호환되는 수신기가 없습니다.
SESSION_ERROR	string 세션을 생성할 수 없거나 세션이 잘못되었습니다.
CHANNEL_ERROR	string 받는 사람의 채널을 사용할 수 없습니다.
LOAD_MEDIA_FAILED	string 미디어를 로드하지 못했습니다.

isAvailable

정적

boolean

클라이언트가 API가 로드되었는지 확인하는 플래그입니다.

ReceiverAction

정적

string

사용자가 확장 프로그램의 수신기에 관해 실행할 수 있는 작업입니다. 전송 작업이 완전히 완료되거나 실패하기 전에 발신자 애플리케이션 UI에서 전환을 표시하는 데 사용할 수 있습니다.

값
CAST	string 사용자가 발신기 애플리케이션을 통해 전송하려는 의도로 수신기를 선택했습니다. 수신자의 정확한 ID는 알 수 없습니다.
중지	string 사용자가 수신기에서 실행 중인 세션 중지를 요청했습니다.

ReceiverAvailability

정적

string

Cast 수신기의 사용 가능 여부를 설명합니다.

값
통화 가능	string 세션 요청과 호환되는 수신기를 하나 이상 사용할 수 있습니다.
UNAVAILABLE	string 사용할 수 있는 수신기가 없습니다.

ReceiverType

정적

string

값
CAST	string 캐스트 수신기(예: Chromecast)
DIAL	string 다이얼 기기(예: 스마트 TV)
행아웃	string 행아웃
커스텀	string 고객이 제공한 맞춤 수신자

SenderPlatform

정적

string

발신기 애플리케이션 플랫폼을 설명합니다.

값
Chrome	string
iOS	string
ANDROID	string

SessionStatus

정적

string

수신기 애플리케이션에 Cast 세션의 상태를 설명합니다.

값
연결	string 세션이 수신 애플리케이션에 연결됩니다.
연결 끊김	string 세션과 수신 애플리케이션의 연결이 끊어집니다. 수신자 애플리케이션은 아직 실행 중일 수도 있고 실행되지 않을 수도 있습니다.
STOPPED	string 수신기 애플리케이션이 중지되었습니다.

시간 초과

정적

null이 아닌 chrome.cast.Timeout

API 메서드의 기본 시간 제한 값(밀리초)입니다.

버전

상수   정적

null이 아닌 숫자 배열

API 버전입니다. 첫 번째 번호는 메이저 버전이고, 두 번째는 마이너 버전입니다.

VolumeControlType

정적

string

볼륨 제어 유형을 설명합니다.

값
관심 유도	string Cast 기기의 볼륨을 변경할 수 있습니다.
해결됨	string Cast 기기의 볼륨이 고정되어 있으며 변경할 수 없습니다.
마스터	string 마스터 시스템 볼륨 컨트롤(예: TV 또는 오디오 기기 볼륨이 변경됨)을 제어합니다.

방법

addReceiverActionListener

정적

addReceiverActionListener(listener)

사용자가 전송을 시작하거나 중지하기 위해 UI를 통해 조치를 취할 때 호출되는 리스너 함수를 추가합니다. 전송기 애플리케이션은 이를 사용하여 전송 작업이 완료되거나 실패하기 전에 사용자 인터페이스에 전환 (예: 로컬에서 미디어 재생 일시중지)을 표시할 수 있습니다.

• 리스너는 반드시 호출되지는 않으며 애플리케이션에서는 리스너에 의존하여 제대로 작동해서는 안 됩니다.
• 리스너에는 작업이 이루어진 수신기가 전달됩니다(있는 경우). 그러나 수신기를 알 수 없으며 null이 대신 전달됩니다.
• 리스너는 사용자가 조치를 취한 후 최대한 빨리 호출됩니다. API를 통해 상태 변경에 관한 애플리케이션에 알림을 받기 전에 이를 호출해야 합니다.

Framework API를 사용하는 경우 대신 cast.framework.CastContext#addEventListener를 사용하고 Cast.framework.CastContextEventType#CAST_STATE_CHANGED 이벤트를 수신 대기합니다.

매개변수
리스너	chrome.cast.ReceiverActionListener 추가할 리스너 함수입니다. 리스너의 첫 번째 인수는 작업이 이루어진 수신자입니다. 리스너의 두 번째 인수는 요청된 작업입니다(chrome.cast.ReceiverAction). 값은 null이 아니어야 합니다.

initialize

정적

initialize(apiConfig, 성공Callback, errorCallback)

API를 초기화합니다. API가 초기화를 완료하고 나면 성공Callback 및 errorCallback이 호출됩니다. sessionListener 및 receiverListener는 이후 언제든지 두 번 이상 호출될 수 있습니다.

Framework API를 사용하는 경우 이 함수 대신 cast.framework.CastContext#setOptions를 사용합니다.

매개변수
apiConfig	chrome.cast.ApiConfig API 초기화를 위한 매개변수가 있는 객체입니다. 값은 null이 아니어야 합니다.
successCallback	함수()
errorCallback	function(non-null chrome.cast.Error) 가능한 오류는 TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING입니다.

logMessage

정적

logMessage(message)

앱의 디버그 메시지를 기록합니다. 사용자가 세부적인 로그를 포함하도록 명시적으로 선택한 경우 이 메시지가 Google에 의견 보고서로 전송될 수 있습니다.

매개변수
메시지	string 로그에 대한 메시지입니다.

지원 중단됨

프레젠테이션 API 기반 Cast SDK에서는 지원되지 않습니다.

사전 캐시

정적

precache(데이터)

데이터를 사전 캐시하기 위한 요청을 보냅니다. 세션이 연결되면 직접 요청을 전송하고 그렇지 않으면 네트워크의 모든 기기로 전송합니다.

매개변수
데이터	string 사전 캐시할 데이터입니다.

지원 중단됨

지원되지 않습니다.

removeReceiverActionListener

정적

removeReceiverActionListener(listener)

이전에 addReceiverActionListener를 사용하여 추가된 리스너 함수를 삭제합니다.

매개변수
리스너	chrome.cast.ReceiverActionListener 삭제할 리스너 함수입니다. 값은 null이 아니어야 합니다.

requestSession

정적

requestSession(successCallback, errorCallback, sessionRequest)

수신자 애플리케이션 세션을 만들거나 참여하도록 요청합니다. 기본적으로 초기화 시 API에 전달된 SessionRequest가 사용됩니다. sessionRequest에서 다른 세션 요청을 전달하여 재정의될 수 있습니다.

Framework API를 사용하는 경우 이 함수 대신 cast.framework.CastContext#requestSession을 사용합니다.

매개변수
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) 가능한 오류는 TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE, EXTENSION_MISSING입니다. 사용자가 수신기를 선택하면 제한 시간 타이머가 시작됩니다. 수신기를 선택하려면 제한 시간이 없는 사용자의 작업이 필요합니다. 세션 요청이 이미 진행 중이면 INVALID_PARAMETER 오류 코드 및 오류를 설명하는 설명과 함께 errorCallback이 호출됩니다.
sessionRequest	선택사항 chrome.cast.SessionRequest 값은 null이 아니어야 합니다.

requestSessionById

정적

requestSessionById(sessionId)

지정된 ID를 사용하는 기존 세션에 참여하기 위한 요청입니다. 세션에 참여하면 세션이 chrome.cast.initialize에서 설정한 sessionListener로 전달됩니다.

이 함수가 호출될 때 지정된 sessionId의 세션을 이미 알고 있는 경우 sessionListener가 즉시 호출됩니다. 그렇지 않은 경우 지정된 sessionId를 가진 세션이 발견되면 sessionListener가 호출됩니다.

매개변수
sessionId	string 참여할 세션의 ID입니다.

setCustomReceivers

정적

setCustomReceivers(receivers, successCallback, errorCallback)

맞춤 수신자 목록을 설정합니다.

매개변수
수신기	null이 아닌 chrome.cast.Receiver의 배열 새 목록 값은 null이 아니어야 합니다.
successCallback	함수()
errorCallback	function(non-null chrome.cast.Error) 가능한 오류는 TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, EXTENSION_MISSRING입니다.

지원 중단됨

프레젠테이션 API 기반 Cast SDK에서는 지원되지 않습니다.

setPageContext

정적

setPageContext(win)

iframe에서 Cast SDK를 로드하는 페이지의 전송 기능을 초기화합니다. SDK가 초기화된 후에 호출해야 합니다.

매개변수
승	창 페이지 창 객체입니다. 값은 null이 아니어야 합니다.

setReceiverDisplayStatus

정적

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

수신자 이름과 디스플레이 상태를 설정합니다. 수신기를 유휴 상태로 표시하려면 displayStatus를 null로 설정합니다.

CUSTOM 수신기에만 유효합니다. 이 수신기가 CAST인 경우 수신기의 displayStatus가 무시됩니다. Cast 수신기 상태는 수신기 애플리케이션에 의해 업데이트됩니다.

매개변수
받는 사람	chrome.cast.Receiver 수신자 값은 null이 아니어야 합니다.
successCallback	함수() 상태 설정이 성공할 때의 콜백입니다.
errorCallback	function(non-null chrome.cast.Error) 가능한 오류는 TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED 및 EXTENSION_MISSING입니다.

지원 중단됨

프레젠테이션 API 기반 Cast SDK에서는 지원되지 않습니다.

unescape

정적

unEsc(이스케이프 처리)는 문자열을 반환

URI 이스케이프 처리된 문자열을 이스케이프 취소하는 유틸리티 메서드입니다. 예를 들어 수신자 친화적인 이름은 URI로 이스케이프 처리된 문자열로 반환됩니다. 필요한 경우 이 메서드를 사용하여 문자열을 이스케이프 취소합니다.

매개변수
이스케이프 처리됨	string 이스케이프 취소할 문자열

반환 값

string 이스케이프 처리되지 않은 문자열

추상 유형

ReceiverActionListener

정적

ReceiverActionListener()