NickParrucci: /* Notes */

2023-02-09T15:23:06Z

Notes

← Older revision		Revision as of 15:23, 9 February 2023
Line 52:		Line 52:
	== Notes ==		== 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.		*Every time when application is launched or moving to foreground, call <code>updateOTT</code> to report the current OTT status to the App SDK.
	*App SDK detects AirPlay and AirPlay mirroring automatically and the application need not report them to App SDK.

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

Admin at 16:17, 5 February 2020

2020-02-05T16:17:17Z

← Older revision		Revision as of 16:17, 5 February 2020
Line 4:		Line 4:
	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).		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 ottInfo dictionary.		*When OTT device is connected, call <code>updateOTT</code> with <code>"ottStatus": "1"</code> and a set of OTT device related parameters in ottInfo dictionary.
	*When OTT device is disconnected, call <code>updateOTT with <code>"ottStatus": "0"</code> in <code>ottInfo</code> dictionary.		*When OTT device is disconnected, call <code>updateOTT</code> with <code>"ottStatus": "0"</code> in <code>ottInfo</code> dictionary.

	== Syntax ==		== Syntax ==

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Use `updateOTT<..."`


2017-05-21T04:09:50Z
Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}}  {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Use <code>updateOTT<..."
New page
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}}  {{CurrentBreadcrumb}}

[[Category:Digital]]

[[Category:iOS 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 ottInfo dictionary.

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



== Syntax ==

<syntaxhighlight lang="objective-c">

– (void)updateOTT:(id)ottInfo;

</syntaxhighlight>



== Input Parameters ==

{| class="wikitable"

|-

! Parameter !! Description

|-

| ottInfo

| A JSON string with the following parameters:

'''OTT device is connected'''

<syntaxhighlight lang="objective-c">

NSDictionary *ottInfo = @

{

   @"ottStatus": @"1",

   @"ottType": @"casting",

   @"ottDevice": @"chromecast",

   @"ottDeviceName": @"Google ChromeCast",

   @"ottDeviceID": @"xxxx-xxxx-xxxx",

   @"ottDeviceManufacturer": @"Google",

   @"ottDeviceModel": @"ChromeCast",

   @"ottDeviceVersion": @"1.0.0"

}

</syntaxhighlight>

'''OTT device is disconnected'''

<syntaxhighlight lang="objective-c">

NSDictionary *ottInfo = @

{

    @"ottStatus": @"0"

}

</syntaxhighlight>

See [[International Metadata]] in International (Germany).

|}



== Output Parameters ==

{| class="wikitable"

|-

! Parameter !! 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.

*App SDK detects AirPlay and AirPlay mirroring automatically and the application need not report them 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 [[optOutStatus]]) and its Demographic ID (using [[demographicId]])

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

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



The two custom parameters to be included in <code>GCKMediaMetadata</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="objective-c">

static NSString * const kGCKMetadataNlsKeyDeviceID = @"kGCKMetadataNlsKeyDeviceID";

static NSString * const kGCKMetadataNlsKeyOptout = @"kGCKMetadataNlsKeyOptout";



GCKMediaMetadata *metadata = [[GCKMediaMetadata alloc] init];

NSUInteger channelIndex = [self.appConfig.channels indexOfObject:self.currentChannel] + 1;

[metadata setString:[NSString stringWithFormat:@"Channel %d", channelIndex] forKey:kGCKMetadataKeyTitle];

[metadata setString:self.currentChannel.urlString forKey:kGCKMetadataKeySubtitle];



// custom parameters

[metadata setString:self.nielsenAppApi.demographicId forKey:kGCKMetadataNlsKeyDeviceID];

[metadata setString:(self.nielsenAppApi.optOutStatus ? @"1": @"0") forKey:kGCKMetadataNlsKeyOptout];



[self logConsole:[NSString stringWithFormat:@"Reporting parameters to receiver. %@: %@, %@: %@", kGCKMetadataNlsKeyDeviceID, self.nielsenAppApi.demographicId, kGCKMetadataNlsKeyOptout, (self.nielsenAppApi.optOutStatus ? @"1": @"0")]];



GCKMediaInformation *mediaInformation =

[[GCKMediaInformation alloc] initWithContentID:self.currentChannel.urlString

                                    streamType:GCKMediaStreamTypeUnknown

                                    contentType:@"video/mp4"

                                    metadata:metadata

                                    streamDuration:0

                                    customData:nil];

[self.chromecastControlChannel loadMedia:mediaInformation autoplay:YES playPosition:0];

</syntaxhighlight>

updateOTT - Revision history

NickParrucci: /* Notes */

Admin at 16:17, 5 February 2020

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Use updateOTT<..."

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Use `updateOTT<..."`