您可通过以下步骤将 Android 发送器应用从 Cast SDK v2 转换为 CAF 发送器(基于 CastContext 单例)。
Cast CAF 发送器 SDK 使用 CastContext 代表您管理 GoogleAPIClient。 CastContext 可为您管理生命周期、错误和回调,大大简化了 Cast 应用的开发工作。
简介
- CAF 发送器仍使用 Android SDK 管理器作为 Google Play 服务的一部分进行分发
- 添加了新软件包,这些软件包会负责遵守 Google Cast 设计核对清单 (
com.google.android.gms.cast.framework.*
) - CAF 发送器提供了符合 Cast 用户体验要求的 widget;v2 不提供任何界面组件,需要您实现这些 widget。
- 现在,使用 Cast API 不再需要使用 GoogleApiClient。
- CAF Sender 中的字幕与 v2 类似。
依赖项
V2 和 CAF 对支持库和 Google Play 服务(9.2.0 或更高版本)的依赖项相同,如支持库功能指南中所述。
CAF 支持的最低 Android SDK 版本是 9 (Gingerbread)。
初始化
在 CAF 中,Cast 框架需要显式初始化步骤。这涉及初始化 CastContext
单例,使用适当的 OptionsProvider
指定 Web 接收器应用 ID 和任何其他全局选项。
public class CastOptionsProvider implements OptionsProvider {
@Override
public CastOptions getCastOptions(Context context) {
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.build();
}
@Override
public List<SessionProvider> getAdditionalSessionProviders(Context context) {
return null;
}
}
在应用 AndroidManifest.xml
文件的“application”标记中声明 OptionsProvider
:
<application>
...
<meta-data
android:name=
"com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.google.sample.cast.refplayer.CastOptionsProvider" />
</application>
在每个 activity 的 onCreate
方法中延迟初始化 CastContext
:
private CastContext mCastContext;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.video_browser);
setupActionBar();
mCastContext = CastContext.getSharedInstance(this);
}
在 v2 中不需要这些步骤。
设备发现
在 CAF 中,当应用进入前台和进入后台时,框架会自动启动和停止发现过程。不应使用 MediaRouteSelector
和 MediaRouter.Callback
。
“投放”按钮和“投放”对话框
与在 v2 中一样,这些组件由 MediaRouter 支持库提供。
“投射”按钮仍由 MediaRouteButton
实现,可作为菜单中的菜单项添加到您的 activity(使用 ActionBar
或 Toolbar
)。
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="android.support.v7.app.MediaRouteActionProvider"
app:showAsAction="always"/>
通过使用 CastButtonFactory
将 MediaRouteButton
连接到 Cast 框架,替换每个 activity 的 onCreateOptionMenu()
方法:
private MenuItem mediaRouteMenuItem;
public boolean onCreateOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
getMenuInflater().inflate(R.menu.browse, menu);
mediaRouteMenuItem =
CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
menu,
R.id.media_route_menu_item);
return true;
}
用户点按该按钮时,系统会自动显示“投射”对话框。
设备控制
在 CAF 中,设备控制主要由框架处理。发送器应用无需处理(也不应尝试处理)连接到设备并使用 GoogleApiClient
启动 Web 接收器应用。发送者和 Web 接收器之间的互动现在以“会话”的形式表示。SessionManager
类负责处理会话生命周期,并根据用户手势自动启动和停止会话:当用户在 Cast 对话框中选择 Cast 设备时,会启动一个会话,然后在用户点按 Cast 对话框中的“停止投射”按钮或发送设备应用本身终止时结束会话。通过向 SessionManager
注册 SessionManagerListener
,发送方应用可以获得会话生命周期事件的通知。SessionManagerListener
回调为所有会话生命周期事件定义回调方法。
CastSession
类表示与 Cast 设备的会话。该类包含用于控制设备音量和静音状态的方法,之前在 v2 中使用 Cast.CastApi
中的方法完成。
在 v2 中,Cast.Listener
回调提供设备状态更改通知,包括音量、静音状态和待机状态等。
在 CAF 中,音量/静音状态变化通知仍通过 Cast.Listener
中的回调方法传送;这些监听器通过 CastSession
注册。所有剩余设备状态通知都通过 CastStateListener
回调进行传送;这些监听器都向 CastSession
注册。当关联的 fragment、activity 或应用转到后台时,请确保仍取消注册监听器。
重新连接逻辑
与 v2 一样,CAF 会尝试重新建立由于暂时性 Wi-Fi 信号丢失或其他网络错误而丢失的网络连接。现在,这在会话级别完成;会话可以在连接中断时进入“已暂停”状态,并在连接恢复时转换回“已连接”状态。在此过程中,框架负责重新连接到 Web 接收器应用,并重新连接所有 Cast 频道。
此外,CAF 还添加了默认启用的自动会话恢复功能(可通过 CastOptions
停用)。如果发送器应用被发送到后台或在 Cast 会话进行期间被终止(通过滑动或崩溃),框架将尝试在发送器应用返回前台或重新启动后恢复该会话;此过程由 SessionManager
自动处理,从而在任何已注册的 SessionManagerListener
实例上发出相应的回调。
自定义渠道注册
在 v2 中,自定义渠道(使用 Cast.MessageReceivedCallback
实现)是通过 Cast.CastApi
注册的。在 CAF 中,自定义渠道改为在 CastSession
实例中注册。可以在 SessionManagerListener.onSessionStarted
回调方法中完成注册。对于媒体应用,不再需要通过 Cast.CastApi.setMessageReceivedCallbacks
明确注册媒体控制渠道;如需了解详情,请参阅以下部分。
媒体控件
v2 类 RemoteMediaPlayer
已弃用,不应继续使用。在 CAF 中,它已被新的 RemoteMediaClient
类所取代,后者在更方便的 API 中提供等效功能。无需显式初始化或注册此对象;如果连接到的 Web 接收器应用支持媒体命名空间,框架将自动实例化该对象,并在会话启动时注册底层媒体频道。
您可将 RemoteMediaClient
作为 CastSession
对象的 getRemoteMediaClient
方法进行访问。
在 v2 中,在 RemoteMediaPlayer
上发出的所有媒体请求都将通过 PendingResult
回调返回 RemoteMediaPlayer.MediaChannelResult
。
在 CAF 中,在 RemoteMediaClient
上发出的所有媒体请求都会通过 PendingResult
回调返回一个 RemoteMediaClient.MediaChannelResult
,该回调可用于跟踪请求的进度和最终结果。
v2 RemoteMediaPlayer
将通过 RemoteMediaPlayer.OnStatusUpdatedListener
发送有关网络接收器上的媒体播放器状态变化的通知。
在 CAF 中,RemoteMediaClient
通过其 RemoteMediaClient.Listener
接口提供等效回调。可以通过 RemoteMediaClient
注册任意数量的监听器,这允许多个发送者组件共享与会话关联的 RemoteMediaClient
的单个实例。
在 v2 中,发送方应用必须负责使界面与网络接收器上的媒体播放器状态保持同步。
在 CAF 中,UIMediaController
类承担了大部分此类责任。
介绍性叠加层
V2 不提供介绍性的叠加层界面。
CAF 提供了一个自定义视图 IntroductoryOverlay
,用于在首次向用户显示“投射”按钮时突出显示该按钮。
迷你控制器
在 v2 中,您需要在发送器应用中从头开始实现迷你控制器。
在 CAF 中,SDK 提供了一个自定义视图 MiniControllerFragment
,您可以将该视图添加到要在其中显示迷你控制器的 activity 的应用布局文件。
通知和锁定屏幕
在 v2 中,SDK 不提供通知和锁定屏幕的控制器。对于该 SDK,您需要使用 Android 框架 API 在发送器应用中构建这些功能。
在 CAF 中,SDK 提供了一个 NotificationsOptions.Builder
,可帮助您将通知和锁定屏幕的媒体控件构建到发送方应用中。在初始化 CastContext
时,可以使用 CastOptions
启用通知和锁定屏幕控件。
public CastOptions getCastOptions(Context context) {
NotificationOptions notificationOptions = new NotificationOptions.Builder()
.setTargetActivityClassName(VideoBrowserActivity.class.getName())
.build();
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
.setNotificationOptions(notificationOptions)
.build();
return new CastOptions.Builder()
.setReceiverApplicationId(context.getString(R.string.app_id))
.setCastMediaOptions(mediaOptions)
.build();
}
展开的控制器
在 v2 中,您需要在发送器应用中从头开始实现展开的控制器。
CAF 提供了一个 UIMediaController
辅助程序类,可让您轻松构建自己的展开式控制器。
CAF 添加了一个预构建的展开控制器 widget ExpandedControllerActivity
,您只需将其添加到自己的应用中即可。您不再需要使用 UIMediaController
实现自定义展开控制器。
音频焦点
在 v2 中,您需要使用 MediaSessionCompat
管理音频焦点。
在 CAF 中,系统会自动管理音频焦点。
调试日志记录
CAF 中没有日志记录选项。
示例应用
我们提供使用 CAF 的 Codelab 教程和示例应用。