GCKAdBreakInfo Class
Stay organized with collections
Save and categorize content based on your preferences.
A class representing an ad break.
- Since
- 3.1
Inherits NSObject, <NSCopying>, and <NSSecureCoding>.
| - (instancetype) initWithPlaybackPosition: |
|
(NSTimeInterval) |
playbackPosition |
|
This is here for backwards compatibility reasons, but will return nil.
A string that uniquely identifies this ad break.
- Since
- 3.3
| - (NSTimeInterval) playbackPosition |
|
readnonatomicassign |
The playback position, in seconds, at which this ad will start playing.
- Since
- 3.1
| - (NSArray<NSString *>*) adBreakClipIDs |
|
readnonatomicstrong |
A list of identifier strings for the ad break clips contained by this ad break.
- Since
- 3.3
Whether the ad break has already been watched or not.
- Since
- 3.3
Whether the ad break is embedded.
- Since
- 4.1
Whether the ad break is expanded.
- Since
- 4.7.0
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGCKAdBreakInfo\u003c/code\u003e class represents an ad break within media content and provides information like ad break ID, playback position, and ad clip IDs.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties to identify the ad break (\u003ccode\u003eadBreakID\u003c/code\u003e), its start time (\u003ccode\u003eplaybackPosition\u003c/code\u003e), and whether it's been watched (\u003ccode\u003ewatched\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eAd breaks can contain multiple ad clips, identified by their \u003ccode\u003eadBreakClipIDs\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis class also indicates if the ad break is embedded within the content (\u003ccode\u003eembedded\u003c/code\u003e) or expanded for interaction (\u003ccode\u003eexpanded\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eAlthough \u003ccode\u003einitWithPlaybackPosition:\u003c/code\u003e exists for backward compatibility, it's deprecated and will return nil; use \u003ccode\u003einit\u003c/code\u003e instead.\u003c/p\u003e\n"]]],[],null,["# GCKAdBreakInfo Class\n\n[Instance Methods](#pub-methods) \\| [Properties](#properties) \nGCKAdBreakInfo Class Reference \n\nOverview\n--------\n\nA class representing an ad break.\n\nSince\n: 3.1\n\nInherits NSObject, \\\u003cNSCopying\\\u003e, and \\\u003cNSSecureCoding\\\u003e.\n\n|----------------|-------------------------------------------------------------------------------------------------------------------------|\n| Instance Method Summary ----------------------- ||\n| (instancetype) | - [initWithPlaybackPosition:](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#abd0f9596d00c76ef98f3d989eba4bbbf) |\n| | This is here for backwards compatibility reasons, but will return nil. [More...](#abd0f9596d00c76ef98f3d989eba4bbbf) |\n| ||\n| (instancetype) | - **init** |\n| ||\n\n|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| Property Summary ---------------- ||\n| NSString \\* | [adBreakID](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#af943493251c68254e9109a26c645582d) |\n| | A string that uniquely identifies this ad break. [More...](#af943493251c68254e9109a26c645582d) |\n| ||\n| NSTimeInterval | [playbackPosition](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#a6930effa46bf9f7c299383c33de9000d) |\n| | The playback position, in seconds, at which this ad will start playing. [More...](#a6930effa46bf9f7c299383c33de9000d) |\n| ||\n| NSArray\\\u003c NSString \\* \\\u003e \\* | [adBreakClipIDs](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#a8632793a71e2ab3b76b10ffdd2a6ee26) |\n| | A list of identifier strings for the ad break clips contained by this ad break. [More...](#a8632793a71e2ab3b76b10ffdd2a6ee26) |\n| ||\n| BOOL | [watched](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#a7d34804396f65b35c5833595f2d2b330) |\n| | Whether the ad break has already been watched or not. [More...](#a7d34804396f65b35c5833595f2d2b330) |\n| ||\n| BOOL | [embedded](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#aee2556b9ef41d0091966a98e6592e592) |\n| | Whether the ad break is embedded. [More...](#aee2556b9ef41d0091966a98e6592e592) |\n| ||\n| BOOL | [expanded](/cast/docs/reference/ios/interface_g_c_k_ad_break_info#a526f66fe8b534cc5f8b6830e72dd7599) |\n| | Whether the ad break is expanded. [More...](#a526f66fe8b534cc5f8b6830e72dd7599) |\n| ||\n\nMethod Detail\n-------------\n\n|--------------------------------------------|---|------------------|--------------------|---|\n| - (instancetype) initWithPlaybackPosition: | | (NSTimeInterval) | *playbackPosition* | |\n\nThis is here for backwards compatibility reasons, but will return nil.\n\nProperty Detail\n---------------\n\n|-----------------------------------------------------------|---------------------|\n| |--------------------------| | - (NSString\\*) adBreakID | | readnonatomicstrong |\n\nA string that uniquely identifies this ad break.\n\nSince\n: 3.3 \n\n|---------------------------------------------------------------------------------|---------------------|\n| |-------------------------------------| | - (NSTimeInterval) playbackPosition | | readnonatomicassign |\n\nThe playback position, in seconds, at which this ad will start playing.\n\nSince\n: 3.1 \n\n|-------------------------------------------------------------------------------------------------|---------------------|\n| |---------------------------------------------| | - (NSArray\\\u003cNSString \\*\\\u003e\\*) adBreakClipIDs | | readnonatomicstrong |\n\nA list of identifier strings for the ad break clips contained by this ad break.\n\nSince\n: 3.3 \n\n|-------------------------------------------|---------------------|\n| |------------------| | - (BOOL) watched | | readnonatomicassign |\n\nWhether the ad break has already been watched or not.\n\nSince\n: 3.3 \n\n|---------------------------------------------|---------------------|\n| |-------------------| | - (BOOL) embedded | | readnonatomicassign |\n\nWhether the ad break is embedded.\n\nSince\n: 4.1 \n\n|---------------------------------------------|---------------------|\n| |-------------------| | - (BOOL) expanded | | readnonatomicassign |\n\nWhether the ad break is expanded.\n\nSince\n: 4.7.0"]]