sendID3: Difference between revisions
From Engineering Client Portal
No edit summary |
m (added DASH reference) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Digital]] | [[Category:Digital]] | ||
[[Category:iOS SDK API Reference]] | [[Category:iOS SDK API Reference]] | ||
This API is a receiver for HLS timed metadata events (ID3 tags) provided through iOS’s NSNotificationCenter notification system. This API filters out Nielsen-specific ID3 tags from the system and buffers the data for transfer to Nielsen’s collection facility. | This API is a receiver for HLS & DASH timed metadata events (ID3 tags) provided through iOS’s NSNotificationCenter notification system. This API filters out Nielsen-specific ID3 tags from the system and buffers the data for transfer to Nielsen’s collection facility. | ||
== Syntax == | |||
<syntaxhighlight lang=" | <syntaxhighlight lang="objective-c"> | ||
– (void) sendID3: (NSString *) data | |||
</syntaxhighlight> | |||
== Input Parameters == | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 15: | Line 17: | ||
|} | |} | ||
== Output Parameters == | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 23: | Line 25: | ||
|} | |} | ||
== Notes == | |||
* During the HLS timed metadata event, only the PRIV frame’s owner ID of the payload (or a copy of the payload) from the NSNotificationCenter notification system shall be passed into this API. This API ignores any owner ID that does not pertain to Nielsen. Since ID3 tags are continuously streamed, every timed metadata event must be captured, stored, and transferred for accuracy of measurement. | * During the HLS timed metadata event, only the PRIV frame’s owner ID of the payload (or a copy of the payload) from the NSNotificationCenter notification system shall be passed into this API. This API ignores any owner ID that does not pertain to Nielsen. Since ID3 tags are continuously streamed, every timed metadata event must be captured, stored, and transferred for accuracy of measurement. | ||
* It is not necessary for the player application to Enable / Disable the Nielsen App SDK component depending on whether Nielsen ID3 tags are present in the stream. This is handled automatically by the SDK | * It is not necessary for the player application to Enable / Disable the Nielsen App SDK component depending on whether Nielsen ID3 tags are present in the stream. This is handled automatically by the SDK | ||
Latest revision as of 15:53, 1 August 2018
This API is a receiver for HLS & DASH timed metadata events (ID3 tags) provided through iOS’s NSNotificationCenter notification system. This API filters out Nielsen-specific ID3 tags from the system and buffers the data for transfer to Nielsen’s collection facility.
Syntax
– (void) sendID3: (NSString *) data
Input Parameters
| Parameter | Description |
|---|---|
| data | An NSString object that contains only the owner ID in the PRIV frame of an ID3 tag. |
Output Parameters
| Output Parameters (Return value) | Description |
|---|---|
| Void |
Notes
- During the HLS timed metadata event, only the PRIV frame’s owner ID of the payload (or a copy of the payload) from the NSNotificationCenter notification system shall be passed into this API. This API ignores any owner ID that does not pertain to Nielsen. Since ID3 tags are continuously streamed, every timed metadata event must be captured, stored, and transferred for accuracy of measurement.
- It is not necessary for the player application to Enable / Disable the Nielsen App SDK component depending on whether Nielsen ID3 tags are present in the stream. This is handled automatically by the SDK