CastService com.connectsdk.service.CastService

CastService provides capabilities for Google Chromecast devices. CastService acts as a layer on top of Google's own Cast SDK, and requires the Cast SDK library to function. CastService provides the following functionality:

  • Media playback
  • Media control
  • Web app launching & two-way communication
  • Volume control

Using Connect SDK for discovery/control of Chromecast devices will result in your app complying with the Google Cast SDK terms of service.

To learn more about Cast SDK, visit the Google Cast SDK Developer site.

Inner Classes

  • ApplicationConnectionResultCallback
  • CastListener
  • ConnectionCallbacks
  • ConnectionFailedListener
  • ConnectionListener
  • LaunchWebAppListener

Methods

CastService (ServiceDescription serviceDescription, ServiceConfig serviceConfig)
Parameters:
  • serviceDescription
  • serviceConfig
String getServiceName ()
CapabilityPriorityLevel getPriorityLevel (Class<?extends CapabilityMethods > clazz)
Parameters:
  • clazz
void connect ()
void disconnect ()
MediaControl getMediaControl ()

Get MediaControl implementation

Returns:

MediaControl

CapabilityPriorityLevel getMediaControlCapabilityLevel ()

Get a capability priority for current implementation

Returns:

CapabilityPriorityLevel

void play (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void pause (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void stop (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void rewind (ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void fastForward (ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void previous (ResponseListener<Object> listener)

This method is deprecated. Use PlaylistControl::previous(ResponseListener<Object> listener) instead.

Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void next (ResponseListener<Object> listener)

This method is deprecated. Use PlaylistControl::next(ResponseListener<Object> listener) instead.

Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void seek (final long position, final ResponseListener<Object> listener)
Parameters:
  • position
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void getDuration (final DurationListener listener)
Parameters:
  • listener –

    (optional) final DurationListener with methods to be called on success or failure

void getPosition (final PositionListener listener)
Parameters:
  • listener –

    (optional) final PositionListener with methods to be called on success or failure

MediaPlayer getMediaPlayer ()
CapabilityPriorityLevel getMediaPlayerCapabilityLevel ()
void getMediaInfo (MediaInfoListener listener)
Parameters:
  • listener –

    (optional) MediaInfoListener with methods to be called on success or failure

ServiceSubscription<MediaInfoListener> subscribeMediaInfo (MediaInfoListener listener)
Parameters:
  • listener –

    (optional) MediaInfoListener with methods to be called on success or failure

void displayImage (String url, String mimeType, String title, String description, String iconSrc, LaunchListener listener)

This method is deprecated. Use MediaPlayer::displayImage(MediaInfo mediaInfo, LaunchListener listener) instead.

Parameters:
  • url
  • mimeType
  • title
  • description
  • iconSrc
  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void displayImage (MediaInfo mediaInfo, LaunchListener listener)
Parameters:
  • mediaInfo
  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void playMedia (String url, String mimeType, String title, String description, String iconSrc, boolean shouldLoop, LaunchListener listener)

This method is deprecated. Use MediaPlayer::playMedia(MediaInfo mediaInfo, boolean shouldLoop, LaunchListener listener) instead.

Parameters:
  • url
  • mimeType
  • title
  • description
  • iconSrc
  • shouldLoop
  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void playMedia (MediaInfo mediaInfo, boolean shouldLoop, LaunchListener listener)
Parameters:
  • mediaInfo
  • shouldLoop
  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void closeMedia (final LaunchSession launchSession, final ResponseListener<Object> listener)
Parameters:
  • launchSession
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

WebAppLauncher getWebAppLauncher ()
CapabilityPriorityLevel getWebAppLauncherCapabilityLevel ()
void launchWebApp (String webAppId, WebAppSession.LaunchListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppSession.LaunchListener with methods to be called on success or failure

void launchWebApp (final String webAppId, final boolean relaunchIfRunning, final WebAppSession.LaunchListener listener)
Parameters:
  • webAppId
  • relaunchIfRunning
  • listener –

    (optional) final WebAppSession.LaunchListener with methods to be called on success or failure

void launchWebApp (String webAppId, JSONObject params, WebAppSession.LaunchListener listener)
Parameters:
  • webAppId
  • params
  • listener –

    (optional) WebAppSession.LaunchListener with methods to be called on success or failure

void launchWebApp (String webAppId, JSONObject params, boolean relaunchIfRunning, WebAppSession.LaunchListener listener)
Parameters:
  • webAppId
  • params
  • relaunchIfRunning
  • listener –

    (optional) WebAppSession.LaunchListener with methods to be called on success or failure

void requestStatus (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void joinApplication (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void joinWebApp (final LaunchSession webAppLaunchSession, final WebAppSession.LaunchListener listener)
Parameters:
  • webAppLaunchSession
  • listener –

    (optional) final WebAppSession.LaunchListener with methods to be called on success or failure

void joinWebApp (String webAppId, WebAppSession.LaunchListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppSession.LaunchListener with methods to be called on success or failure

void closeWebApp (LaunchSession launchSession, final ResponseListener<Object> listener)
Parameters:
  • launchSession
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void pinWebApp (String webAppId, ResponseListener<Object> listener)
Parameters:
  • webAppId
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void unPinWebApp (String webAppId, ResponseListener<Object> listener)
Parameters:
  • webAppId
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void isWebAppPinned (String webAppId, WebAppPinStatusListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppPinStatusListener with methods to be called on success or failure

ServiceSubscription<WebAppPinStatusListener> subscribeIsWebAppPinned (String webAppId, WebAppPinStatusListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppPinStatusListener with methods to be called on success or failure

VolumeControl getVolumeControl ()
CapabilityPriorityLevel getVolumeControlCapabilityLevel ()
void volumeUp (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void volumeDown (final ResponseListener<Object> listener)
Parameters:
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void setVolume (final float volume, final ResponseListener<Object> listener)
Parameters:
  • volume
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void getVolume (VolumeListener listener)
Parameters:
  • listener –

    (optional) VolumeListener with methods to be called on success or failure

void setMute (final boolean isMute, final ResponseListener<Object> listener)
Parameters:
  • isMute
  • listener –

    (optional) final ResponseListener< Object > with methods to be called on success or failure

void getMute (final MuteListener listener)
Parameters:
  • listener –

    (optional) final MuteListener with methods to be called on success or failure

ServiceSubscription<VolumeListener> subscribeVolume (VolumeListener listener)
Parameters:
  • listener –

    (optional) VolumeListener with methods to be called on success or failure

ServiceSubscription<MuteListener> subscribeMute (MuteListener listener)
Parameters:
  • listener –

    (optional) MuteListener with methods to be called on success or failure

void getPlayState (PlayStateListener listener)

Get the current state of playback

Parameters:
  • listener –

    (optional) PlayStateListener with methods to be called on success or failure

GoogleApiClient getApiClient ()
boolean isConnectable ()
boolean isConnected ()
ServiceSubscription<PlayStateListener> subscribePlayState (PlayStateListener listener)

Subscribe for playback state changes

Parameters:
  • listener –

    receives play state notifications

Returns:

ServiceSubscription<PlayStateListener>

void unsubscribe (URLServiceSubscription<?> subscription)
Parameters:
  • subscription
List<URLServiceSubscription<?>> getSubscriptions ()
void setSubscriptions (List< URLServiceSubscription<?>> subscriptions)
Parameters:
  • subscriptions
static DiscoveryFilter discoveryFilter ()
static void setApplicationID (String id)
Parameters:
  • id
static String getApplicationID ()

Inherited Methods

void connect ()

Will attempt to connect to the DeviceService. The failure/success will be reported back to the DeviceServiceListener. If the connection attempt reveals that pairing is required, the DeviceServiceListener will also be notified in that event.

void disconnect ()

Will attempt to disconnect from the DeviceService. The failure/success will be reported back to the DeviceServiceListener.

boolean isConnected ()

Whether the DeviceService is currently connected

boolean isConnectable ()
void cancelPairing ()

Explicitly cancels pairing in services that require pairing. In some services, this will hide a prompt that is displaying on the device.

void sendPairingKey (String pairingKey)

Will attempt to pair with the DeviceService with the provided pairingData. The failure/success will be reported back to the DeviceServiceListener.

Parameters:
  • pairingKey –

    Data to be used for pairing. The type of this parameter will vary depending on what type of pairing is required, but is likely to be a string (pin code, pairing key, etc).

List<String> getCapabilities ()
boolean hasCapability (String capability)

Test to see if the capabilities array contains a given capability. See the individual Capability classes for acceptable capability values.

It is possible to append a wildcard search term .Any to the end of the search term. This method will return true for capabilities that match the term up to the wildcard.

Example: Launcher.App.Any

Parameters:
  • capability –

    Capability to test against

boolean hasAnyCapability (String... capabilities)

Test to see if the capabilities array contains at least one capability in a given set of capabilities. See the individual Capability classes for acceptable capability values.

See hasCapability: for a description of the wildcard feature provided by this method.

Parameters:
  • capabilities –

    Set of capabilities to test against

boolean hasCapabilities (List<String> capabilities)

Test to see if the capabilities array contains a given set of capabilities. See the individual Capability classes for acceptable capability values.

See hasCapability: for a description of the wildcard feature provided by this method.

Parameters:
  • capabilities –

    List of capabilities to test against

ServiceDescription getServiceDescription ()
ServiceConfig getServiceConfig ()
JSONObject toJSONObject ()
String getServiceName ()

Name of the DeviceService (webOS, Chromecast, etc)

void closeLaunchSession (LaunchSession launchSession, ResponseListener<Object> listener)

Closes the session on the first screen device. Depending on the sessionType, the associated service will have different ways of handling the close functionality.

Parameters:
  • launchSession –

    LaunchSession to close

  • listener –

    (optional) listener to be called on success/failure

MediaPlayer getMediaPlayer ()
CapabilityPriorityLevel getMediaPlayerCapabilityLevel ()
void getMediaInfo (MediaInfoListener listener)
Parameters:
  • listener –

    (optional) MediaInfoListener with methods to be called on success or failure

ServiceSubscription<MediaInfoListener> subscribeMediaInfo (MediaInfoListener listener)
Parameters:
  • listener –

    (optional) MediaInfoListener with methods to be called on success or failure

void displayImage (MediaInfo mediaInfo, LaunchListener listener)

Display an image on the device. Not all devices support all of the parameters -- supply as many as you have available.

Related capabilities:
  • MediaPlayer.Display.Image
  • MediaPlayer.MediaData.Title
  • MediaPlayer.MediaData.Description
  • MediaPlayer.MediaData.Thumbnail
  • MediaPlayer.MediaData.MimeType
Parameters:
  • mediaInfo –

    Object of MediaInfo class which includes all the information about an image to display.

  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void playMedia (MediaInfo mediaInfo, boolean shouldLoop, LaunchListener listener)

Play an audio or video file on the device. Not all devices support all of the parameters -- supply as many as you have available.

Related capabilities:
  • MediaPlayer.Play.Video
  • MediaPlayer.Play.Audio
  • MediaPlayer.MediaData.Title
  • MediaPlayer.MediaData.Description
  • MediaPlayer.MediaData.Thumbnail
  • MediaPlayer.MediaData.MimeType
Parameters:
  • mediaInfo –

    Object of MediaInfo class which includes all the information about an image to display.

  • shouldLoop –

    Whether to automatically loop playback

  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void closeMedia (LaunchSession launchSession, ResponseListener<Object> listener)

Close a running media session. Because media is handled differently on different platforms, it is required to keep track of LaunchSession and MediaControl objects to control that media session in the future. LaunchSession will be required to close the media and mediaControl will be required to control the media.

Related capabilities:
  • MediaPlayer.Close
Parameters:
  • launchSession –

    LaunchSession object for use in closing media instance

  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

MediaControl getMediaControl ()

Get MediaControl implementation

Returns:

MediaControl

CapabilityPriorityLevel getMediaControlCapabilityLevel ()

Get a capability priority for current implementation

Returns:

CapabilityPriorityLevel

void play (ResponseListener<Object> listener)

Send play command.

Related capabilities:
  • MediaControl.Play
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void pause (ResponseListener<Object> listener)

Send pause command.

Related capabilities:
  • MediaControl.Pause
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void stop (ResponseListener<Object> listener)

Send play command.

Related capabilities:
  • MediaControl.Stop
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void rewind (ResponseListener<Object> listener)

Send rewind command.

Related capabilities:
  • MediaControl.Rewind
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void fastForward (ResponseListener<Object> listener)

Send play command.

Related capabilities:
  • MediaControl.FastForward
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void previous (ResponseListener<Object> listener)

This method is deprecated. Use PlaylistControl::previous(ResponseListener<Object> listener) instead.

Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void next (ResponseListener<Object> listener)

This method is deprecated. Use PlaylistControl::next(ResponseListener<Object> listener) instead.

Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void seek (long position, ResponseListener<Object> listener)

Seeks to a new position within the current media item

Related capabilities:
  • MediaControl.Seek
Parameters:
  • position –

    The new position, in milliseconds from the beginning of the stream

  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void getDuration (DurationListener listener)

Get the current media duration in milliseconds

Parameters:
  • listener –

    (optional) DurationListener with methods to be called on success or failure

void getPosition (PositionListener listener)

Get the current playback position in milliseconds

Parameters:
  • listener –

    (optional) PositionListener with methods to be called on success or failure

void getPlayState (PlayStateListener listener)

Get the current state of playback

Parameters:
  • listener –

    (optional) PlayStateListener with methods to be called on success or failure

ServiceSubscription<PlayStateListener> subscribePlayState (PlayStateListener listener)

Subscribe for playback state changes

Parameters:
  • listener –

    receives play state notifications

Returns:

ServiceSubscription<PlayStateListener>

VolumeControl getVolumeControl ()
CapabilityPriorityLevel getVolumeControlCapabilityLevel ()
void volumeUp (ResponseListener<Object> listener)

Sends the volume up command to the device.

Related capabilities:
  • VolumeControl.UpDown
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void volumeDown (ResponseListener<Object> listener)

Sends the volume down command to the device.

Related capabilities:
  • VolumeControl.UpDown
Parameters:
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void setVolume (float volume, ResponseListener<Object> listener)

Set the volume of the device.

Related capabilities:
  • VolumeControl.Set
Parameters:
  • volume –

    Volume as a float between 0.0 and 1.0

  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void getVolume (VolumeListener listener)

Get the current volume of the device.

Related capabilities:
  • VolumeControl.Get
Parameters:
  • listener –

    (optional) VolumeListener with methods to be called on success or failure

void setMute (boolean isMute, ResponseListener<Object> listener)

Set the current volume.

Related capabilities:
  • VolumeControl.Mute.Set
Parameters:
  • isMute
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void getMute (MuteListener listener)

Get the current mute state.

Related capabilities:
  • VolumeControl.Mute.Get
Parameters:
  • listener –

    (optional) MuteListener with methods to be called on success or failure

ServiceSubscription<VolumeListener> subscribeVolume (VolumeListener listener)

Subscribe to the volume on the TV.

Related capabilities:
  • VolumeControl.Subscribe
Parameters:
  • listener –

    (optional) VolumeListener with methods to be called on success or failure

ServiceSubscription<MuteListener> subscribeMute (MuteListener listener)

Subscribe to the mute state on the TV.

Related capabilities:
  • VolumeControl.Mute.Subscribe
Parameters:
  • listener –

    (optional) MuteListener with methods to be called on success or failure

WebAppLauncher getWebAppLauncher ()
CapabilityPriorityLevel getWebAppLauncherCapabilityLevel ()
void launchWebApp (String webAppId, LaunchListener listener)

Launch a web application on the TV.

Related capabilities:
  • WebAppLauncher.Launch
  • WebAppLauncher.Launch.Params

    if launching with params

Parameters:
  • webAppId –

    ID of web app assigned by platform vendor

  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void joinWebApp (LaunchSession webAppLaunchSession, LaunchListener listener)

Join an active web app without launching/relaunching. If the app is not running/joinable, the failure block will be called immediately.

Related capabilities:
  • WebAppLauncher.Send
  • WebAppLauncher.Receive
Parameters:
  • webAppLaunchSession –

    LaunchSession for the web app to be joined

  • listener –

    (optional) LaunchListener with methods to be called on success or failure

void closeWebApp (LaunchSession launchSession, ResponseListener<Object> listener)

Closes a web app with the provided LaunchSession.

Related capabilities:
  • WebAppLauncher.Close
Parameters:
  • launchSession –

    LaunchSession associated with the web app to be closed

  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void pinWebApp (String webAppId, ResponseListener<Object> listener)
Parameters:
  • webAppId
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void unPinWebApp (String webAppId, ResponseListener<Object> listener)
Parameters:
  • webAppId
  • listener –

    (optional) ResponseListener< Object > with methods to be called on success or failure

void isWebAppPinned (String webAppId, WebAppPinStatusListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppPinStatusListener with methods to be called on success or failure

ServiceSubscription<WebAppPinStatusListener> subscribeIsWebAppPinned (String webAppId, WebAppPinStatusListener listener)
Parameters:
  • webAppId
  • listener –

    (optional) WebAppPinStatusListener with methods to be called on success or failure

void onLoseReachability (DeviceServiceReachability reachability)
Parameters:
  • reachability
void unsubscribe (URLServiceSubscription<?> subscription)
Parameters:
  • subscription
void sendCommand (ServiceCommand<?> command)
Parameters:
  • command