Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference Use `upd..."`


2017-05-21T07:29:08Z
Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference Use <code>upd..."
New page
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}}

[[Category:Digital]]

[[Category:Android SDK API Reference]]

Use <code>updateOTT</code> method to notify App SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).

*When OTT device is connected, call <code>updateOTT</code> with <code>"ottStatus": "1"</code> and a set of OTT device related parameters in <code>ottInfo</code> JSONObject.

*When OTT device is disconnected, call <code>updateOTT</code> with <code>"ottStatus": "0"</code> in <code>ottInfo</code> JSONObject.



== Syntax ==

<syntaxhighlight lang="java">

public void updateOTT(JSONObject ottInfo)

</syntaxhighlight>



== Input Parameters ==

{| class="wikitable"

|-

! Parameter !! Description

|-

| ottMetadata

| A JSON object with the following parameters

'''OTT device is connected'''

<syntaxhighlight lang="java">

new JSONObject()

   .put("ottStatus": "1")

   .put("ottType": "casting")

   .put("ottDevice": "chromecast")

   .put("ottDeviceName": "Google ChromeCast")

   .put("ottDeviceID": "xxxx-xxxx-xxxx")

   .put("ottDeviceManufacturer": "Google")

   .put("ottDeviceModel": "ChromeCast")

   .put("ottDeviceVersion": "1.0.0");

</syntaxhighlight>





'''OTT device is disconnected'''

<syntaxhighlight lang="java">

new JSONObject()

   .put("ottStatus": "0")

</syntaxhighlight>

See [[International Metadata]] (Germany).

|}



== Output Parameters ==

{| class="wikitable"

|-

! Output Parameters (Return value) !! Description

|-

| Void || 

|}



== Notes ==

*Every time when application is launched or moving to foreground, call <code>updateOTT</code> to report the current OTT status to the App SDK.

*The application needs to report all the possible OTT types (casting, screen mirroring, and any other types) to App SDK.



=== Communicating with the Chromecast Receiver App ===

SDK cannot communicate directly with the Receiver App running on the Chromecast as it needs access to the Google Casting framework. Alternatively, App SDK requires the application to pass the data to the Receiver App. The application should:

*Retrieve the Opt-Out status on the device (using [[getOptOutStatus()]]) and its Demographic ID (using [[getDemographicId()]])

*Relay the retrieved details / values to the Receiver App, as additional parameters in <code>MediaMetadata</code> payload.

**Create the metadata information for this purpose, using <code>MediaMetadata</code>.

The two custom parameters to be included in <code>MediaMetadata</code> are:

*<code>kGCKMetadataNlsKeyDeviceID</code> for device ID.

*<code>kGCKMetadataNlsKeyOptout</code> for Opt-out status (0 or 1).

Below is a sample code snippet on how the application should retrieve and relay the information from App SDK to Receiver App.

<syntaxhighlight lang="java">

MediaMetadata mediaMetadata = new MediaMetadata( MediaMetadata.MEDIA_TYPE_MOVIE );

mediaMetadata.putString( MediaMetadata.KEY_TITLE, channelName.getText().toString());



//Custom parameters

mediaMetadata.putString( MEDIA_METADATA_KEY_DEVICE_ID, mAppSdk.getDemographicId() );

mediaMetadata.putString( MEDIA_METADATA_KEY_OPTOUT_STATE, mAppSdk.getOptOutStatus() ? “1”:”0″);



MediaInfo mediaInfo = new MediaInfo.Builder(mNowPlayingUrl)

            .setContentType( getString( R.string.content_type_mp4 ) )

            .setStreamType( MediaInfo.STREAM_TYPE_BUFFERED )

            .setMetadata( mediaMetadata )

            .build();

</syntaxhighlight>

updateOTT() - Revision history

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference Use upd..."

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Android SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Android SDK API Reference Use `upd..."`