FireTVService¶

com.connectsdk.service.FireTVService

FireTVService provides capabilities for FireTV devices. FireTVService acts as a layer on top of Fling SDK, and requires the Fling SDK library to function. FireTVService provides the following functionality:

Media playback
Media control

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

Properties¶

final String ID = “FireTV”

Inner Classes¶

ConvertResult
PlayStateSubscription
Subscription

Methods¶

FireTVService (ServiceDescription serviceDescription, ServiceConfig serviceConfig)

Parameters:

serviceDescription
serviceConfig

void connect ()

Prepare a service for usage

boolean isConnected ()

Check if service is ready

boolean isConnectable ()

Check if service implements connect/disconnect methods

void disconnect ()

Disconnect a service and close all subscriptions

CapabilityPriorityLevel getPriorityLevel (Class<?extends CapabilityMethods > clazz)

Get a priority level for a particular capability

Parameters:

clazz

MediaPlayer getMediaPlayer ()

Get MediaPlayer implementation

CapabilityPriorityLevel getMediaPlayerCapabilityLevel ()

Get MediaPlayer priority level

void getMediaInfo (final MediaInfoListener listener)

Get MediaInfo available only during playback otherwise returns an error

Parameters:

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

ServiceSubscription <MediaInfoListener> subscribeMediaInfo (MediaInfoListener listener)

Not supported

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, final LaunchListener listener)

Display an image with metadata

Parameters:

url – media source
mimeType
title
description
iconSrc
listener – (optional) final 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)

Play audio/video

Parameters:

url – media source
mimeType
title
description
iconSrc
shouldLoop – skipped in current implementation
listener – (optional) LaunchListener with methods to be called on success or failure

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

Stop and close media player on FireTV. In current implementation it’s similar to stop method

Parameters:

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

void displayImage (MediaInfo mediaInfo, LaunchListener listener)

Display an image with metadata

Parameters:

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

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

Play audio/video

Parameters:

mediaInfo
shouldLoop – skipped in current implementation
listener – (optional) LaunchListener with methods to be called on success or failure

MediaControl getMediaControl ()

Get MediaControl capability. It should be used only during media playback.

CapabilityPriorityLevel getMediaControlCapabilityLevel ()

Get MediaControl priority level

void play (ResponseListener <Object> listener)

Play current media.

Parameters:

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

void pause (ResponseListener <Object> listener)

Pause current media.

Parameters:

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

void stop (ResponseListener <Object> listener)

Stop current media and close FireTV application.

Parameters:

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

void rewind (ResponseListener <Object> listener)

Not supported

Parameters:

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

void fastForward (ResponseListener <Object> listener)

Not supported

Parameters:

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

void previous (ResponseListener <Object> listener)

Not supported

Parameters:

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

void next (ResponseListener <Object> listener)

Not supported

Parameters:

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

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

Seek current media.

Parameters:

position – time in milliseconds
listener – (optional) ResponseListener< Object > with methods to be called on success or failure

void getDuration (final DurationListener listener)

Get current media duration.

Parameters:

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

void getPosition (final PositionListener listener)

Get playback position

Parameters:

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

void getPlayState (final PlayStateListener listener)

Get playback state

Parameters:

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

ServiceSubscription <PlayStateListener> subscribePlayState (final PlayStateListener listener)

Subscribe to playback state. Only single instance of subscription is available. Each new call returns the same subscription object.

Parameters:

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

static DiscoveryFilter discoveryFilter ()

Get filter instance for this service which contains a name of service and id. It is used in discovery process

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>

void onLoseReachability (DeviceServiceReachability reachability)

Parameters:

reachability

void unsubscribe (URLServiceSubscription<?> subscription)

Parameters:

subscription

void sendCommand (ServiceCommand<?> command)

Parameters:

command