이 페이지에는 Android TV Receiver 앱을 맞춤설정하는 데 사용할 수 있는 기능에 관한 코드 스니펫과 설명이 포함되어 있습니다.
라이브러리 구성
Android TV 앱에서 Cast Connect API를 사용할 수 있도록 하려면 다음 단계를 따르세요.
-
애플리케이션 모듈 디렉터리에서
build.gradle
파일을 엽니다. -
나열된
repositories
에google()
가 포함되어 있는지 확인합니다.repositories { google() }
-
앱의 대상 기기 유형에 따라 종속 항목에 최신 버전의 라이브러리를 추가합니다.
-
Android 수신기 앱:
dependencies { implementation 'com.google.android.gms:play-services-cast-tv:21.1.1' implementation 'com.google.android.gms:play-services-cast:22.0.0' }
-
Android 발신기 앱:
dependencies { implementation 'com.google.android.gms:play-services-cast:21.1.1' implementation 'com.google.android.gms:play-services-cast-framework:22.0.0' }
-
Android 수신기 앱:
-
변경사항을 저장하고 툴바에서
Sync Project with Gradle Files
를 클릭합니다.
-
Podfile
가google-cast-sdk
4.8.3 이상을 타겟팅하는지 확인합니다. -
iOS 14 이상을 타겟팅합니다. 자세한 내용은 출시 노트를 참고하세요.
platform: ios, '14' def target_pods pod 'google-cast-sdk', '~>4.8.3' end
- Chromium 브라우저 버전 M87 이상이 필요합니다.
-
프로젝트에 Web Sender API 라이브러리 추가
<script src="//www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>
AndroidX 요구사항
새 버전의 Google Play 서비스를 사용하려면 앱을 업데이트하여 androidx
네임스페이스를 사용해야 합니다. AndroidX로 이전 안내를 따르세요.
Android TV 앱 - 기본 요건
Android TV 앱에서 Cast Connect를 지원하려면 미디어 세션에서 이벤트를 만들고 지원해야 합니다. 미디어 세션에서 제공하는 데이터는 미디어 상태에 관한 기본 정보(예: 위치, 재생 상태 등)를 제공합니다. Cast Connect 라이브러리에서도 미디어 세션을 사용하여 일시중지와 같은 특정 메시지를 발신기에서 수신했을 때 신호를 보냅니다.
미디어 세션 및 미디어 세션을 초기화하는 방법에 관한 자세한 내용은 미디어 세션 가이드 작업을 참고하세요.
미디어 세션 수명 주기
앱은 재생이 시작될 때 미디어 세션을 만들고 더 이상 제어할 수 없을 때 이를 해제해야 합니다. 예를 들어 앱이 동영상 앱인 경우 사용자가 '뒤로'를 선택하여 다른 콘텐츠를 탐색하거나 앱을 백그라운드로 전환하여 재생 활동을 종료하면 세션을 해제해야 합니다. 앱이 음악 앱인 경우 앱에서 더 이상 미디어를 재생하지 않으면 세션을 해제해야 합니다.
세션 상태 업데이트 중
미디어 세션의 데이터는 플레이어의 상태에 따라 최신 상태로 유지되어야 합니다. 예를 들어 재생이 일시중지되면 재생 상태와 지원되는 작업을 업데이트해야 합니다. 다음 표에는 업데이트할 책임이 있는 상태가 나와 있습니다.
MediaMetadataCompat
메타데이터 필드 | 설명 |
---|---|
METADATA_KEY_TITLE (필수) | 미디어 제목입니다. |
METADATA_KEY_DISPLAY_SUBTITLE | 부제목입니다. |
METADATA_KEY_DISPLAY_ICON_URI | 아이콘 URL입니다. |
METADATA_KEY_DURATION (필수) | 미디어 길이입니다. |
METADATA_KEY_MEDIA_URI | Content ID입니다. |
METADATA_KEY_ARTIST | 아티스트 |
METADATA_KEY_ALBUM | 앨범 |
PlaybackStateCompat
필수 메서드 | 설명 |
---|---|
setActions() | 지원되는 미디어 명령어를 설정합니다. |
setState() | 재생 상태와 현재 위치를 설정합니다. |
MediaSessionCompat
필수 메서드 | 설명 |
---|---|
setRepeatMode() | 반복 모드를 설정합니다. |
setShuffleMode() | 셔플 모드를 설정합니다. |
setMetadata() | 미디어 메타데이터를 설정합니다. |
setPlaybackState() | 재생 상태를 설정합니다. |
private fun updateMediaSession() { val metadata = MediaMetadataCompat.Builder() .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI, mMovie.getCardImageUrl()) .build() val playbackState = PlaybackStateCompat.Builder() .setState( PlaybackStateCompat.STATE_PLAYING, player.getPosition(), player.getPlaybackSpeed(), System.currentTimeMillis() ) .build() mediaSession.setMetadata(metadata) mediaSession.setPlaybackState(playbackState) }
private void updateMediaSession() { MediaMetadataCompat metadata = new MediaMetadataCompat.Builder() .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle") .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI,mMovie.getCardImageUrl()) .build(); PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setState( PlaybackStateCompat.STATE_PLAYING, player.getPosition(), player.getPlaybackSpeed(), System.currentTimeMillis()) .build(); mediaSession.setMetadata(metadata); mediaSession.setPlaybackState(playbackState); }
전송 컨트롤 처리
앱은 미디어 세션 전송 제어 콜백을 구현해야 합니다. 다음 표에는 처리해야 하는 전송 제어 작업이 나와 있습니다.
MediaSessionCompat.Callback
작업 | 설명 |
---|---|
onPlay() | 재개 |
onPause() | 일시중지 |
onSeekTo() | 특정 위치로 이동 |
onStop() | 현재 미디어 중지 |
class MyMediaSessionCallback : MediaSessionCompat.Callback() { override fun onPause() { // Pause the player and update the play state. ... } override fun onPlay() { // Resume the player and update the play state. ... } override fun onSeekTo (long pos) { // Seek and update the play state. ... } ... } mediaSession.setCallback( MyMediaSessionCallback() );
public MyMediaSessionCallback extends MediaSessionCompat.Callback { public void onPause() { // Pause the player and update the play state. ... } public void onPlay() { // Resume the player and update the play state. ... } public void onSeekTo (long pos) { // Seek and update the play state. ... } ... } mediaSession.setCallback(new MyMediaSessionCallback());
Cast 지원 구성
발신자 애플리케이션에서 실행 요청을 전송하면 애플리케이션 네임스페이스로 인텐트가 생성됩니다. 애플리케이션은 이를 처리하고 TV 앱이 실행될 때 CastReceiverContext
객체의 인스턴스를 만드는 작업을 담당합니다. CastReceiverContext
객체는 TV 앱이 실행되는 동안 Cast와 상호작용하는 데 필요합니다. 이 객체를 사용하면 TV 애플리케이션이 연결된 모든 발신자로부터 전송되는 Cast 미디어 메시지를 수락할 수 있습니다.
Android TV 설정
시작 인텐트 필터 추가
발신기 앱의 실행 인텐트를 처리하려는 활동에 새 인텐트 필터를 추가합니다.
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="com.google.android.gms.cast.tv.action.LAUNCH" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
수신기 옵션 제공자 지정
CastReceiverOptions
를 제공하려면 ReceiverOptionsProvider
를 구현해야 합니다.
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) .setStatusText("My App") .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) .setStatusText("My App") .build(); } }
그런 다음 AndroidManifest
에서 옵션 제공자를 지정합니다.
<meta-data
android:name="com.google.android.gms.cast.tv.RECEIVER_OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.example.mysimpleatvapplication.MyReceiverOptionsProvider" />
ReceiverOptionsProvider
는 CastReceiverContext
가 초기화될 때 CastReceiverOptions
를 제공하는 데 사용됩니다.
Cast 수신기 컨텍스트
앱이 생성될 때 CastReceiverContext
를 초기화합니다.
override fun onCreate() { CastReceiverContext.initInstance(this) ... }
@Override public void onCreate() { CastReceiverContext.initInstance(this); ... }
앱이 포그라운드로 이동할 때 CastReceiverContext
를 시작합니다.
CastReceiverContext.getInstance().start()
CastReceiverContext.getInstance().start();
동영상 앱 또는 백그라운드 재생을 지원하지 않는 앱의 경우 앱이 백그라운드로 전환된 후 CastReceiverContext
에서 stop()
를 호출합니다.
// Player has stopped. CastReceiverContext.getInstance().stop()
// Player has stopped. CastReceiverContext.getInstance().stop();
또한 앱이 백그라운드 재생을 지원하는 경우 백그라운드에서 재생이 중지되면 CastReceiverContext
에서 stop()
를 호출합니다.
특히 네이티브 앱에 여러 활동이 있는 경우 androidx.lifecycle
라이브러리의 LifecycleObserver를 사용하여 CastReceiverContext.start()
및 CastReceiverContext.stop()
호출을 관리하는 것이 좋습니다. 이렇게 하면 서로 다른 활동에서 start()
및 stop()
를 호출할 때 경합 상태가 방지됩니다.
// Create a LifecycleObserver class. class MyLifecycleObserver : DefaultLifecycleObserver { override fun onStart(owner: LifecycleOwner) { // App prepares to enter foreground. CastReceiverContext.getInstance().start() } override fun onStop(owner: LifecycleOwner) { // App has moved to the background or has terminated. CastReceiverContext.getInstance().stop() } } // Add the observer when your application is being created. class MyApplication : Application() { fun onCreate() { super.onCreate() // Initialize CastReceiverContext. CastReceiverContext.initInstance(this /* android.content.Context */) // Register LifecycleObserver ProcessLifecycleOwner.get().lifecycle.addObserver( MyLifecycleObserver()) } }
// Create a LifecycleObserver class. public class MyLifecycleObserver implements DefaultLifecycleObserver { @Override public void onStart(LifecycleOwner owner) { // App prepares to enter foreground. CastReceiverContext.getInstance().start(); } @Override public void onStop(LifecycleOwner owner) { // App has moved to the background or has terminated. CastReceiverContext.getInstance().stop(); } } // Add the observer when your application is being created. public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); // Initialize CastReceiverContext. CastReceiverContext.initInstance(this /* android.content.Context */); // Register LifecycleObserver ProcessLifecycleOwner.get().getLifecycle().addObserver( new MyLifecycleObserver()); } }
// In AndroidManifest.xml set MyApplication as the application class
<application
...
android:name=".MyApplication">
MediaManager에 MediaSession 연결
MediaSession
을 만들 때 현재 MediaSession
토큰도 CastReceiverContext
에 제공하여 명령어를 전송할 위치와 미디어 재생 상태를 검색할 위치를 알 수 있도록 해야 합니다.
val mediaManager: MediaManager = receiverContext.getMediaManager() mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken())
MediaManager mediaManager = receiverContext.getMediaManager(); mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken());
비활성 재생으로 인해 MediaSession
을 해제할 때 MediaManager
에서 null 토큰을 설정해야 합니다.
myPlayer.stop() mediaSession.release() mediaManager.setSessionCompatToken(null)
myPlayer.stop(); mediaSession.release(); mediaManager.setSessionCompatToken(null);
앱이 백그라운드에 있을 때 미디어 재생을 지원하는 경우 앱이 백그라운드로 전송될 때 CastReceiverContext.stop()
를 호출하는 대신 앱이 백그라운드에 있고 더 이상 미디어를 재생하지 않을 때만 호출해야 합니다. 예를 들면 다음과 같습니다.
class MyLifecycleObserver : DefaultLifecycleObserver { ... // App has moved to the background. override fun onPause(owner: LifecycleOwner) { mIsBackground = true myStopCastReceiverContextIfNeeded() } } // Stop playback on the player. private fun myStopPlayback() { myPlayer.stop() myStopCastReceiverContextIfNeeded() } // Stop the CastReceiverContext when both the player has // stopped and the app has moved to the background. private fun myStopCastReceiverContextIfNeeded() { if (mIsBackground && myPlayer.isStopped()) { CastReceiverContext.getInstance().stop() } }
public class MyLifecycleObserver implements DefaultLifecycleObserver { ... // App has moved to the background. @Override public void onPause(LifecycleOwner owner) { mIsBackground = true; myStopCastReceiverContextIfNeeded(); } } // Stop playback on the player. private void myStopPlayback() { myPlayer.stop(); myStopCastReceiverContextIfNeeded(); } // Stop the CastReceiverContext when both the player has // stopped and the app has moved to the background. private void myStopCastReceiverContextIfNeeded() { if (mIsBackground && myPlayer.isStopped()) { CastReceiverContext.getInstance().stop(); } }
Cast Connect에서 Exoplayer 사용
Exoplayer
를 사용하는 경우 MediaSessionConnector
를 사용하여 변경사항을 수동으로 추적하는 대신 세션과 재생 상태를 비롯한 모든 관련 정보를 자동으로 유지할 수 있습니다.
MediaSessionConnector.MediaButtonEventHandler
는 기본적으로 MediaSessionCompat.Callback
에서 처리하는 setMediaButtonEventHandler(MediaButtonEventHandler)
를 호출하여 MediaButton 이벤트를 처리하는 데 사용할 수 있습니다.
앱에 MediaSessionConnector
를 통합하려면 플레이어 활동 클래스 또는 미디어 세션을 관리하는 위치에 다음을 추가합니다.
class PlayerActivity : Activity() { private var mMediaSession: MediaSessionCompat? = null private var mMediaSessionConnector: MediaSessionConnector? = null private var mMediaManager: MediaManager? = null override fun onCreate(savedInstanceState: Bundle?) { ... mMediaSession = MediaSessionCompat(this, LOG_TAG) mMediaSessionConnector = MediaSessionConnector(mMediaSession!!) ... } override fun onStart() { ... mMediaManager = receiverContext.getMediaManager() mMediaManager!!.setSessionCompatToken(currentMediaSession.getSessionToken()) mMediaSessionConnector!!.setPlayer(mExoPlayer) mMediaSessionConnector!!.setMediaMetadataProvider(mMediaMetadataProvider) mMediaSession!!.isActive = true ... } override fun onStop() { ... mMediaSessionConnector!!.setPlayer(null) mMediaSession!!.release() mMediaManager!!.setSessionCompatToken(null) ... } }
public class PlayerActivity extends Activity { private MediaSessionCompat mMediaSession; private MediaSessionConnector mMediaSessionConnector; private MediaManager mMediaManager; @Override protected void onCreate(Bundle savedInstanceState) { ... mMediaSession = new MediaSessionCompat(this, LOG_TAG); mMediaSessionConnector = new MediaSessionConnector(mMediaSession); ... } @Override protected void onStart() { ... mMediaManager = receiverContext.getMediaManager(); mMediaManager.setSessionCompatToken(currentMediaSession.getSessionToken()); mMediaSessionConnector.setPlayer(mExoPlayer); mMediaSessionConnector.setMediaMetadataProvider(mMediaMetadataProvider); mMediaSession.setActive(true); ... } @Override protected void onStop() { ... mMediaSessionConnector.setPlayer(null); mMediaSession.release(); mMediaManager.setSessionCompatToken(null); ... } }
발신자 앱 설정
Cast Connect 지원 사용 설정
Cast Connect 지원으로 송신자 앱을 업데이트한 후 LaunchOptions
에서 androidReceiverCompatible
플래그를 true로 설정하여 준비 상태를 선언할 수 있습니다.
play-services-cast-framework
버전 19.0.0
이상이 필요합니다.
androidReceiverCompatible
플래그는 CastOptions
의 일부인 LaunchOptions
에 설정됩니다.
class CastOptionsProvider : OptionsProvider { override fun getCastOptions(context: Context?): CastOptions { val launchOptions: LaunchOptions = Builder() .setAndroidReceiverCompatible(true) .build() return CastOptions.Builder() .setLaunchOptions(launchOptions) ... .build() } }
public class CastOptionsProvider implements OptionsProvider { @Override public CastOptions getCastOptions(Context context) { LaunchOptions launchOptions = new LaunchOptions.Builder() .setAndroidReceiverCompatible(true) .build(); return new CastOptions.Builder() .setLaunchOptions(launchOptions) ... .build(); } }
google-cast-sdk
버전 v4.4.8
이상이 필요합니다.
androidReceiverCompatible
플래그는 GCKCastOptions
의 일부인 GCKLaunchOptions
에 설정됩니다.
let options = GCKCastOptions(discoveryCriteria: GCKDiscoveryCriteria(applicationID: kReceiverAppID)) ... let launchOptions = GCKLaunchOptions() launchOptions.androidReceiverCompatible = true options.launchOptions = launchOptions GCKCastContext.setSharedInstanceWith(options)
Chromium 브라우저 버전 M87
이상이 필요합니다.
const context = cast.framework.CastContext.getInstance(); const castOptions = new cast.framework.CastOptions(); castOptions.receiverApplicationId = kReceiverAppID; castOptions.androidReceiverCompatible = true; context.setOptions(castOptions);
Cast 개발자 콘솔 설정
Android TV 앱 구성
Cast 개발자 콘솔에 Android TV 앱의 패키지 이름을 추가하여 Cast 앱 ID와 연결합니다.
개발자 기기 등록
Cast 개발자 콘솔에서 개발에 사용할 Android TV 기기의 일련번호를 등록합니다.
등록하지 않으면 보안상의 이유로 Cast Connect가 Google Play 스토어에서 설치된 앱에서만 작동합니다.
Cast 개발을 위해 Cast 또는 Android TV 기기를 등록하는 방법에 관한 자세한 내용은 등록 페이지를 참고하세요.
미디어 로드
Android TV 앱에서 이미 딥 링크 지원을 구현한 경우 Android TV 매니페스트에 유사한 정의가 구성되어 있어야 합니다.
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<data android:scheme="https"/>
<data android:host="www.example.com"/>
<data android:pathPattern=".*"/>
</intent-filter>
</activity>
발신자에서 항목별로 로드
발신자의 경우 로드 요청의 미디어 정보에서 entity
를 설정하여 딥 링크를 전달할 수 있습니다.
val mediaToLoad = MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") ... .build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") ... .build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id") ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Chromium 브라우저 버전 M87
이상이 필요합니다.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); mediaInfo.entity = 'https://example.com/watch/some-id'; ... let request = new chrome.cast.media.LoadRequest(mediaInfo); request.credentials = 'user-credentials'; ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
로드 명령어는 딥 링크와 개발자 콘솔에서 정의한 패키지 이름이 있는 인텐트를 통해 전송됩니다.
발신자에 ATV 사용자 인증 정보 설정
웹 수신기 앱과 Android TV 앱이 서로 다른 딥 링크와 credentials
를 지원할 수 있습니다 (예: 두 플랫폼에서 인증을 다르게 처리하는 경우). 이 문제를 해결하려면 Android TV에 대체 entity
및 credentials
를 제공하면 됩니다.
val mediaToLoad = MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") .setAtvEntity("myscheme://example.com/atv/some-id") ... .build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") .setAtvCredentials("atv-user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id") .setEntity("https://example.com/watch/some-id") .setAtvEntity("myscheme://example.com/atv/some-id") ... .build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") .setAtvCredentials("atv-user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id") mediaInfoBuilder.atvEntity = "myscheme://example.com/atv/some-id" ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" mediaLoadRequestDataBuilder.atvCredentials = "atv-user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Chromium 브라우저 버전 M87
이상이 필요합니다.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); mediaInfo.entity = 'https://example.com/watch/some-id'; mediaInfo.atvEntity = 'myscheme://example.com/atv/some-id'; ... let request = new chrome.cast.media.LoadRequest(mediaInfo); request.credentials = 'user-credentials'; request.atvCredentials = 'atv-user-credentials'; ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
웹 수신기 앱이 실행되면 로드 요청에서 entity
및 credentials
를 사용합니다. 그러나 Android TV 앱이 실행되면 SDK는 entity
및 credentials
를 atvEntity
및 atvCredentials
(지정된 경우)로 재정의합니다.
Content ID 또는 MediaQueueData로 로드
entity
또는 atvEntity
를 사용하지 않고 미디어 정보에서 콘텐츠 ID 또는 콘텐츠 URL을 사용하거나 더 자세한 미디어 로드 요청 데이터를 사용하는 경우 Android TV 앱에 다음과 같은 사전 정의된 인텐트 필터를 추가해야 합니다.
<activity android:name="com.example.activity">
<intent-filter>
<action android:name="com.google.android.gms.cast.tv.action.LOAD"/>
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>
발신자 측에서는 항목별 로드와 마찬가지로 콘텐츠 정보로 로드 요청을 만들고 load()
를 호출할 수 있습니다.
val mediaToLoad = MediaInfo.Builder("some-id").build() val loadRequest = MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build() remoteMediaClient.load(loadRequest)
MediaInfo mediaToLoad = new MediaInfo.Builder("some-id").build(); MediaLoadRequestData loadRequest = new MediaLoadRequestData.Builder() .setMediaInfo(mediaToLoad) .setCredentials("user-credentials") ... .build(); remoteMediaClient.load(loadRequest);
let mediaInfoBuilder = GCKMediaInformationBuilder(contentId: "some-id") ... mediaInformation = mediaInfoBuilder.build() let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder() mediaLoadRequestDataBuilder.mediaInformation = mediaInformation mediaLoadRequestDataBuilder.credentials = "user-credentials" ... let mediaLoadRequestData = mediaLoadRequestDataBuilder.build() remoteMediaClient?.loadMedia(with: mediaLoadRequestData)
Chromium 브라우저 버전 M87
이상이 필요합니다.
let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4'); ... let request = new chrome.cast.media.LoadRequest(mediaInfo); ... cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);
로드 요청 처리
활동에서 이러한 로드 요청을 처리하려면 활동 수명 주기 콜백에서 인텐트를 처리해야 합니다.
class MyActivity : Activity() { override fun onStart() { super.onStart() val mediaManager = CastReceiverContext.getInstance().getMediaManager() // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } // For some cases, a new load intent triggers onNewIntent() instead of // onStart(). override fun onNewIntent(intent: Intent) { val mediaManager = CastReceiverContext.getInstance().getMediaManager() // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } }
public class MyActivity extends Activity { @Override protected void onStart() { super.onStart(); MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(getIntent())) { // If the SDK recognizes the intent, you should early return. return; } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } // For some cases, a new load intent triggers onNewIntent() instead of // onStart(). @Override protected void onNewIntent(Intent intent) { MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); // Pass the intent to the SDK. You can also do this in onCreate(). if (mediaManager.onNewIntent(intent)) { // If the SDK recognizes the intent, you should early return. return; } // If the SDK doesn't recognize the intent, you can handle the intent with // your own logic. ... } }
MediaManager
는 인텐트가 로드 인텐트라고 감지하면 인텐트에서 MediaLoadRequestData
객체를 추출하고 MediaLoadCommandCallback.onLoad()
를 호출합니다.
로드 요청을 처리하려면 이 메서드를 재정의해야 합니다. 콜백은 MediaManager.onNewIntent()
를 호출하기 전에 등록해야 합니다 (Activity 또는 애플리케이션 onCreate()
메서드에 있는 것이 좋음).
class MyActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.setMediaLoadCommandCallback(MyMediaLoadCommandCallback()) } } class MyMediaLoadCommandCallback : MediaLoadCommandCallback() { override fun onLoad( senderId: String?, loadRequestData: MediaLoadRequestData ): Task{ return Tasks.call { // Resolve the entity into your data structure and load media. val mediaInfo = loadRequestData.getMediaInfo() if (!checkMediaInfoSupported(mediaInfo)) { // Throw MediaException to indicate load failure. throw MediaException( MediaError.Builder() .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED) .setReason(MediaError.ERROR_REASON_INVALID_REQUEST) .build() ) } myFillMediaInfo(MediaInfoWriter(mediaInfo)) myPlayerLoad(mediaInfo.getContentUrl()) // Update media metadata and state (this clears all previous status // overrides). castReceiverContext.getMediaManager() .setDataFromLoad(loadRequestData) ... castReceiverContext.getMediaManager().broadcastMediaStatus() // Return the resolved MediaLoadRequestData to indicate load success. return loadRequestData } } private fun myPlayerLoad(contentURL: String) { myPlayer.load(contentURL) // Update the MediaSession state. val playbackState: PlaybackStateCompat = Builder() .setState( player.getState(), player.getPosition(), System.currentTimeMillis() ) ... .build() mediaSession.setPlaybackState(playbackState) }
public class MyActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.setMediaLoadCommandCallback(new MyMediaLoadCommandCallback()); } } public class MyMediaLoadCommandCallback extends MediaLoadCommandCallback { @Override public TaskonLoad(String senderId, MediaLoadRequestData loadRequestData) { return Tasks.call(() -> { // Resolve the entity into your data structure and load media. MediaInfo mediaInfo = loadRequestData.getMediaInfo(); if (!checkMediaInfoSupported(mediaInfo)) { // Throw MediaException to indicate load failure. throw new MediaException( new MediaError.Builder() .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED) .setReason(MediaError.ERROR_REASON_INVALID_REQUEST) .build()); } myFillMediaInfo(new MediaInfoWriter(mediaInfo)); myPlayerLoad(mediaInfo.getContentUrl()); // Update media metadata and state (this clears all previous status // overrides). castReceiverContext.getMediaManager() .setDataFromLoad(loadRequestData); ... castReceiverContext.getMediaManager().broadcastMediaStatus(); // Return the resolved MediaLoadRequestData to indicate load success. return loadRequestData; }); } private void myPlayerLoad(String contentURL) { myPlayer.load(contentURL); // Update the MediaSession state. PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setState( player.getState(), player.getPosition(), System.currentTimeMillis()) ... .build(); mediaSession.setPlaybackState(playbackState); }
로드 인텐트를 처리하려면 인텐트를 정의된 데이터 구조(로드 요청의 경우 MediaLoadRequestData
)로 파싱하면 됩니다.
미디어 명령어 지원
기본 재생 컨트롤 지원
기본 통합 명령어에는 미디어 세션과 호환되는 명령어가 포함됩니다. 이러한 명령어는 미디어 세션 콜백을 통해 알림을 받습니다. 이를 지원하려면 미디어 세션에 콜백을 등록해야 합니다 (이미 하고 있을 수도 있음).
private class MyMediaSessionCallback : MediaSessionCompat.Callback() { override fun onPause() { // Pause the player and update the play state. myPlayer.pause() } override fun onPlay() { // Resume the player and update the play state. myPlayer.play() } override fun onSeekTo(pos: Long) { // Seek and update the play state. myPlayer.seekTo(pos) } ... } mediaSession.setCallback(MyMediaSessionCallback())
private class MyMediaSessionCallback extends MediaSessionCompat.Callback { @Override public void onPause() { // Pause the player and update the play state. myPlayer.pause(); } @Override public void onPlay() { // Resume the player and update the play state. myPlayer.play(); } @Override public void onSeekTo(long pos) { // Seek and update the play state. myPlayer.seekTo(pos); } ... } mediaSession.setCallback(new MyMediaSessionCallback());
Cast 제어 명령어 지원
skipAd()
또는 setActiveMediaTracks()
와 같이 MediaSession
에서 사용할 수 없는 일부 Cast 명령어가 있습니다.
또한 전송 대기열이 MediaSession
대기열과 완전히 호환되지 않으므로 일부 대기열 명령어는 여기에서 구현해야 합니다.
class MyMediaCommandCallback : MediaCommandCallback() { override fun onSkipAd(requestData: RequestData?): Task<Void?> { // Skip your ad ... return Tasks.forResult(null) } } val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.setMediaCommandCallback(MyMediaCommandCallback())
public class MyMediaCommandCallback extends MediaCommandCallback { @Override public TaskonSkipAd(RequestData requestData) { // Skip your ad ... return Tasks.forResult(null); } } MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.setMediaCommandCallback(new MyMediaCommandCallback());
지원되는 미디어 명령어 지정
Cast 수신기와 마찬가지로 Android TV 앱은 지원되는 명령어를 지정해야 하므로 전송자가 특정 UI 컨트롤을 사용 설정하거나 사용 중지할 수 있습니다. MediaSession
의 일부인 명령어의 경우 PlaybackStateCompat
에서 명령어를 지정합니다.
추가 명령어는 MediaStatusModifier
에 지정해야 합니다.
// Set media session supported commands val playbackState: PlaybackStateCompat = PlaybackStateCompat.Builder() .setActions(PlaybackStateCompat.ACTION_PLAY or PlaybackStateCompat.ACTION_PAUSE) .setState(PlaybackStateCompat.STATE_PLAYING) .build() mediaSession.setPlaybackState(playbackState) // Set additional commands in MediaStatusModifier val mediaManager = CastReceiverContext.getInstance().getMediaManager() mediaManager.getMediaStatusModifier() .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT)
// Set media session supported commands PlaybackStateCompat playbackState = new PlaybackStateCompat.Builder() .setActions(PlaybackStateCompat.ACTION_PLAY | PlaybackStateCompat.ACTION_PAUSE) .setState(PlaybackStateCompat.STATE_PLAYING) .build(); mediaSession.setPlaybackState(playbackState); // Set additional commands in MediaStatusModifier MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager(); mediaManager.getMediaStatusModifier() .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT);
지원되지 않는 버튼 숨기기
Android TV 앱이 기본 미디어 제어만 지원하지만 웹 수신기 앱이 고급 제어를 지원하는 경우 Android TV 앱으로 전송할 때 발신자 앱이 올바르게 작동하는지 확인해야 합니다. 예를 들어 Android TV 앱이 재생 속도 변경을 지원하지 않지만 웹 수신기 앱이 지원하는 경우 각 플랫폼에서 지원되는 작업을 올바르게 설정하고 발신자 앱이 UI를 올바르게 렌더링하는지 확인해야 합니다.
MediaStatus 수정
트랙, 광고, 라이브, 현재 재생목록과 같은 고급 기능을 지원하려면 Android TV 앱에서 MediaSession
를 통해 확인할 수 없는 추가 정보를 제공해야 합니다.
이를 위해 MediaStatusModifier
클래스를 제공합니다. MediaStatusModifier
는 항상 CastReceiverContext
에서 설정한 MediaSession
에서 작동합니다.
MediaStatus
를 만들고 브로드캐스트하려면 다음 단계를 따르세요.
val mediaManager: MediaManager = castReceiverContext.getMediaManager() val statusModifier: MediaStatusModifier = mediaManager.getMediaStatusModifier() statusModifier .setLiveSeekableRange(seekableRange) .setAdBreakStatus(adBreakStatus) .setCustomData(customData) mediaManager.broadcastMediaStatus()
MediaManager mediaManager = castReceiverContext.getMediaManager(); MediaStatusModifier statusModifier = mediaManager.getMediaStatusModifier(); statusModifier .setLiveSeekableRange(seekableRange) .setAdBreakStatus(adBreakStatus) .setCustomData(customData); mediaManager.broadcastMediaStatus();
클라이언트 라이브러리는 MediaSession
에서 기본 MediaStatus
를 가져옵니다. Android TV 앱은 MediaStatus
수정자를 통해 추가 상태를 지정하고 상태를 재정의할 수 있습니다.
일부 상태 및 메타데이터는 MediaSession
와 MediaStatusModifier
에서 모두 설정할 수 있습니다. MediaSession
에서만 설정하는 것이 적극 권장됩니다. 수정자를 사용하여 MediaSession
의 상태를 재정의할 수도 있습니다. 하지만 수정자의 상태는 항상 MediaSession
에서 제공하는 값보다 우선순위가 높으므로 권장하지 않습니다.
전송하기 전에 MediaStatus 가로채기
웹 수신기 SDK와 마찬가지로 전송하기 전에 마무리 작업을 실행하려면 MediaStatusInterceptor
를 지정하여 전송할 MediaStatus
를 처리하면 됩니다. 전송되기 전에 MediaStatus
를 조작하기 위해 MediaStatusWriter
를 전달합니다.
mediaManager.setMediaStatusInterceptor(object : MediaStatusInterceptor { override fun intercept(mediaStatusWriter: MediaStatusWriter) { // Perform customization. mediaStatusWriter.setCustomData(JSONObject("{data: \"my Hello\"}")) } })
mediaManager.setMediaStatusInterceptor(new MediaStatusInterceptor() { @Override public void intercept(MediaStatusWriter mediaStatusWriter) { // Perform customization. mediaStatusWriter.setCustomData(new JSONObject("{data: \"my Hello\"}")); } });
사용자 인증 정보 처리
Android TV 앱에서는 특정 사용자만 앱 세션을 실행하거나 참여하도록 허용할 수 있습니다. 예를 들어 다음과 같은 경우에만 발신자가 실행하거나 참여하도록 허용합니다.
- 발신자 앱이 ATV 앱과 동일한 계정 및 프로필에 로그인되어 있습니다.
- 발신자 앱이 ATV 앱과 동일한 계정으로 로그인되어 있지만 프로필이 다릅니다.
앱이 여러 사용자 또는 익명의 사용자를 처리할 수 있는 경우 추가 사용자를 ATV 세션에 참여하도록 허용할 수 있습니다. 사용자가 사용자 인증 정보를 제공하는 경우 진행 상황과 기타 사용자 데이터를 적절하게 추적할 수 있도록 ATV 앱에서 사용자 인증 정보를 처리해야 합니다.
발신기 앱이 Android TV 앱을 실행하거나 이에 참여할 때 발신기 앱은 세션에 참여하는 사용자를 나타내는 사용자 인증 정보를 제공해야 합니다.
발신자가 Android TV 앱을 실행하고 참여하기 전에 실행 검사기를 지정하여 발신자 사용자 인증 정보가 허용되는지 확인할 수 있습니다. 그렇지 않으면 Cast Connect SDK가 웹 수신기 실행으로 대체됩니다.
발신자 앱 실행 사용자 인증 정보 데이터
발신자 측에서는 CredentialsData
를 지정하여 세션에 참여하는 사용자를 나타낼 수 있습니다.
credentials
는 ATV 앱에서 이해할 수 있는 한 사용자가 정의할 수 있는 문자열입니다. credentialsType
는 CredentialsData
가 제공되는 플랫폼을 정의하거나 맞춤 값일 수 있습니다. 기본적으로 전송되는 플랫폼으로 설정됩니다.
CredentialsData
는 시작 또는 조인 시간에만 Android TV 앱에 전달됩니다. 연결되어 있는 동안 다시 설정하면 Android TV 앱에 전달되지 않습니다. 연결되어 있는 동안 발신자가 프로필을 전환하는 경우 세션에 계속 머물러 있거나 새 프로필이 세션과 호환되지 않는다고 생각되면 SessionManager.endCurrentCastSession(boolean stopCasting)
를 호출할 수 있습니다.
각 발신자의 CredentialsData
는 CastReceiverContext
에서 getSenders
를 사용하여 SenderInfo
를 가져오고, getCastLaunchRequest()
에서 CastLaunchRequest
를 가져온 다음 getCredentialsData()
를 사용하여 가져올 수 있습니다.
play-services-cast-framework
버전 19.0.0
이상이 필요합니다.
CastContext.getSharedInstance().setLaunchCredentialsData( CredentialsData.Builder() .setCredentials("{\"userId\": \"abc\"}") .build() )
CastContext.getSharedInstance().setLaunchCredentialsData( new CredentialsData.Builder() .setCredentials("{\"userId\": \"abc\"}") .build());
google-cast-sdk
버전 v4.8.3
이상이 필요합니다.
옵션이 설정된 후 언제든지 호출할 수 있습니다.
GCKCastContext.setSharedInstanceWith(options)
.
GCKCastContext.sharedInstance().setLaunch( GCKCredentialsData(credentials: "{\"userId\": \"abc\"}")
Chromium 브라우저 버전 M87
이상이 필요합니다.
옵션이 설정된 후 언제든지 호출할 수 있습니다.
cast.framework.CastContext.getInstance().setOptions(options);
.
let credentialsData = new chrome.cast.CredentialsData("{\"userId\": \"abc\"}"); cast.framework.CastContext.getInstance().setLaunchCredentialsData(credentialsData);
ATV 실행 요청 검사기 구현
CredentialsData
는 발신자가 실행하거나 참여하려고 할 때 Android TV 앱에 전달됩니다. LaunchRequestChecker
를 구현할 수 있습니다.
를 클릭하여 이 요청을 허용하거나 거부합니다.
요청이 거부되면 ATV 앱에 기본적으로 실행되는 대신 웹 수신기가 로드됩니다. ATV가 실행 또는 참여를 요청하는 사용자를 처리할 수 없는 경우 요청을 거부해야 합니다. 요청하는 사용자와 다른 사용자가 ATV 앱에 로그인되어 있고 앱에서 사용자 인증 정보 전환을 처리할 수 없는 경우나 현재 ATV 앱에 로그인한 사용자가 없는 경우를 예로 들 수 있습니다.
요청이 허용되면 ATV 앱이 실행됩니다. 앱이 사용자가 ATV 앱에 로그인하지 않았을 때 로드 요청을 전송하는지 또는 사용자 불일치가 있는지에 따라 이 동작을 맞춤설정할 수 있습니다. 이 동작은 LaunchRequestChecker
에서 완전히 맞춤설정할 수 있습니다.
CastReceiverOptions.LaunchRequestChecker
인터페이스를 구현하는 클래스를 만듭니다.
class MyLaunchRequestChecker : LaunchRequestChecker { override fun checkLaunchRequestSupported(launchRequest: CastLaunchRequest): Task{ return Tasks.call { myCheckLaunchRequest( launchRequest ) } } } private fun myCheckLaunchRequest(launchRequest: CastLaunchRequest): Boolean { val credentialsData = launchRequest.getCredentialsData() ?: return false // or true if you allow anonymous users to join. // The request comes from a mobile device, e.g. checking user match. return if (credentialsData.credentialsType == CredentialsData.CREDENTIALS_TYPE_ANDROID) { myCheckMobileCredentialsAllowed(credentialsData.getCredentials()) } else false // Unrecognized credentials type. }
public class MyLaunchRequestChecker implements CastReceiverOptions.LaunchRequestChecker { @Override public TaskcheckLaunchRequestSupported(CastLaunchRequest launchRequest) { return Tasks.call(() -> myCheckLaunchRequest(launchRequest)); } } private boolean myCheckLaunchRequest(CastLaunchRequest launchRequest) { CredentialsData credentialsData = launchRequest.getCredentialsData(); if (credentialsData == null) { return false; // or true if you allow anonymous users to join. } // The request comes from a mobile device, e.g. checking user match. if (credentialsData.getCredentialsType().equals(CredentialsData.CREDENTIALS_TYPE_ANDROID)) { return myCheckMobileCredentialsAllowed(credentialsData.getCredentials()); } // Unrecognized credentials type. return false; }
그런 다음 ReceiverOptionsProvider
에서 설정합니다.
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) ... .setLaunchRequestChecker(MyLaunchRequestChecker()) .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) ... .setLaunchRequestChecker(new MyLaunchRequestChecker()) .build(); } }
LaunchRequestChecker
에서 true
를 확인하면 ATV 앱이 실행되고 false
는 웹 수신기 앱을 실행합니다.
맞춤 메시지 보내기 및 받기
Cast 프로토콜을 사용하면 발신자와 수신기 애플리케이션 간에 맞춤 문자열 메시지를 보낼 수 있습니다. CastReceiverContext
를 초기화하기 전에 메시지를 전송할 네임스페이스 (채널)를 등록해야 합니다.
Android TV: 맞춤 네임스페이스 지정
설정하는 동안 CastReceiverOptions
에서 지원되는 네임스페이스를 지정해야 합니다.
class MyReceiverOptionsProvider : ReceiverOptionsProvider { override fun getOptions(context: Context?): CastReceiverOptions { return CastReceiverOptions.Builder(context) .setCustomNamespaces( Arrays.asList("urn:x-cast:com.example.cast.mynamespace") ) .build() } }
public class MyReceiverOptionsProvider implements ReceiverOptionsProvider { @Override public CastReceiverOptions getOptions(Context context) { return new CastReceiverOptions.Builder(context) .setCustomNamespaces( Arrays.asList("urn:x-cast:com.example.cast.mynamespace")) .build(); } }
Android TV: 메시지 보내기
// If senderId is null, then the message is broadcasted to all senders. CastReceiverContext.getInstance().sendMessage( "urn:x-cast:com.example.cast.mynamespace", senderId, customString)
// If senderId is null, then the message is broadcasted to all senders. CastReceiverContext.getInstance().sendMessage( "urn:x-cast:com.example.cast.mynamespace", senderId, customString);
Android TV: 맞춤 네임스페이스 메시지 수신
class MyCustomMessageListener : MessageReceivedListener { override fun onMessageReceived( namespace: String, senderId: String?, message: String ) { ... } } CastReceiverContext.getInstance().setMessageReceivedListener( "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());
class MyCustomMessageListener implements CastReceiverContext.MessageReceivedListener { @Override public void onMessageReceived( String namespace, String senderId, String message) { ... } } CastReceiverContext.getInstance().setMessageReceivedListener( "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());