GoogleInteractiveMediaAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
IMAVideoStitcherLiveStreamRequest
Data object describing a stream request for a Google video stitcher live serving stream.
-
The live stream ID for the stream.
Declaration
Swift
var liveStreamEventID: String { get }
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull liveStreamEventID;
-
The region for the stream.
Declaration
Swift
var region: String { get }
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull region;
-
The project number for the stream.
Declaration
Swift
var projectNumber: String { get }
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull projectNumber;
-
The OAuth Token for the stream.
Declaration
Swift
var oAuthToken: String { get }
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull OAuthToken;
-
The session options are used to set Video Stitcher-specific parameters
for this Video Stitcher stream request.
Declaration
Swift
var videoStitcherSessionOptions: [String : Any]? { get set }
Objective-C
@property (nonatomic, copy, nullable) NSDictionary<NSString *, id> *videoStitcherSessionOptions;
-
Initializes a stream request instance with the given network code and custom
asset key. Uses the given ad display container to display the stream.
Declaration
Swift
init(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)
Objective-C
- (nonnull instancetype)
initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID
region:(nonnull NSString *)region
projectNumber:(nonnull NSString *)projectNumber
OAuthToken:(nonnull NSString *)OAuthToken
networkCode:(nonnull NSString *)networkCode
customAssetKey:(nonnull NSString *)customAssetKey
adDisplayContainer:
(nonnull IMAAdDisplayContainer *)adDisplayContainer
videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
userContext:(nullable id)userContext
videoStitcherSessionOptions:
(nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;
Parameters
liveStreamEventID
|
The live stream ID for the stream.
|
region
|
The region for the stream.
|
projectNumber
|
The project number for the stream.
|
OAuthToken
|
The OAuth Token for the stream.
|
networkCode
|
The network code for the stream.
|
customAssetKey
|
The asset key for the stream.
|
adDisplayContainer
|
The IMAAdDisplayContainer for rendering the ad UI.
|
videoDisplay
|
The IMAVideoDisplay where the stream will be played.
|
userContext
|
The user context for tracking requests (optional)
|
videoStitcherSessionOptions
|
limited set of cloud session overrides (optional)
|
Return Value
The IMAVideoStitcherLiveStreamRequest instance.
-
Initializes a stream request instance with the given network code and custom
asset key. Uses the given ad display container to display the stream. Uses the picture in picture
proxy to track PIP events.
Declaration
Swift
init(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)
Objective-C
- (nonnull instancetype)
initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID
region:(nonnull NSString *)region
projectNumber:(nonnull NSString *)projectNumber
OAuthToken:(nonnull NSString *)OAuthToken
networkCode:(nonnull NSString *)networkCode
customAssetKey:(nonnull NSString *)customAssetKey
adDisplayContainer:
(nonnull IMAAdDisplayContainer *)adDisplayContainer
videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
pictureInPictureProxy:
(nullable IMAPictureInPictureProxy *)pictureInPictureProxy
userContext:(nullable id)userContext
videoStitcherSessionOptions:
(nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;
Parameters
liveStreamEventID
|
The live stream ID for the stream.
|
region
|
The region for the stream.
|
projectNumber
|
The project number for the stream.
|
OAuthToken
|
The OAuth Token for the stream.
|
networkCode
|
The network code for the stream.
|
customAssetKey
|
The asset key for the stream.
|
adDisplayContainer
|
The IMAAdDisplayContainer for rendering the ad UI.
|
videoDisplay
|
The IMAVideoDisplay where the stream will be played.
|
pictureInPictureProxy
|
The IMAPictureInPictureProxy for tracking PIP events.
|
userContext
|
The user context for tracking requests (optional)
|
videoStitcherSessionOptions
|
limited set of cloud session overrides (optional)
|
Return Value
The IMAVideoStitcherLiveStreamRequest instance.
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 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eIMAVideoStitcherLiveStreamRequest\u003c/code\u003e is a data object used to request Google Video Stitcher live streams.\u003c/p\u003e\n"],["\u003cp\u003eIt requires essential stream identifiers like \u003ccode\u003eliveStreamEventID\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, \u003ccode\u003eprojectNumber\u003c/code\u003e, and \u003ccode\u003eOAuthToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eInitialization involves providing network/asset details, ad display container, video display, and optionally user context and picture-in-picture proxy.\u003c/p\u003e\n"],["\u003cp\u003eVideo Stitcher specific parameters can be set through \u003ccode\u003evideoStitcherSessionOptions\u003c/code\u003e dictionary.\u003c/p\u003e\n"],["\u003cp\u003eThis class facilitates the playback of Google Video Stitcher live streams with ad integration in your application.\u003c/p\u003e\n"]]],["The `IMAVideoStitcherLiveStreamRequest` object describes a request for a live Google video stitcher stream. Key properties include `liveStreamEventID`, `region`, `projectNumber`, and `OAuthToken`, essential for identifying and authenticating the stream. It also holds `videoStitcherSessionOptions` to set Video Stitcher parameters. Initialization requires these identifiers alongside `networkCode`, `customAssetKey`, `adDisplayContainer`, and `videoDisplay`, and optionally `pictureInPictureProxy`, and `userContext`. These parameters are needed to initialize the stream and render the ad UI.\n"],null,["# GoogleInteractiveMediaAds Framework Reference\n\nIMAVideoStitcherLiveStreamRequest\n=================================\n\n @interface IMAVideoStitcherLiveStreamRequest : ../Classes/IMAPodStreamRequest.html\n\nData object describing a stream request for a Google video stitcher live serving stream.\n- `\n ``\n ``\n `\n\n ### [liveStreamEventID](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)liveStreamEventID)\n\n `\n ` \n The live stream ID for the stream. \n\n #### Declaration\n\n Swift \n\n var liveStreamEventID: String { get }\n\n Objective-C \n\n @property (nonatomic, readonly) NSString *_Nonnull liveStreamEventID;\n\n- `\n ``\n ``\n `\n\n ### [region](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)region)\n\n `\n ` \n The region for the stream. \n\n #### Declaration\n\n Swift \n\n var region: String { get }\n\n Objective-C \n\n @property (nonatomic, readonly) NSString *_Nonnull region;\n\n- `\n ``\n ``\n `\n\n ### [projectNumber](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)projectNumber)\n\n `\n ` \n The project number for the stream. \n\n #### Declaration\n\n Swift \n\n var projectNumber: String { get }\n\n Objective-C \n\n @property (nonatomic, readonly) NSString *_Nonnull projectNumber;\n\n- `\n ``\n ``\n `\n\n ### [OAuthToken](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)OAuthToken)\n\n `\n ` \n The OAuth Token for the stream. \n\n #### Declaration\n\n Swift \n\n var oAuthToken: String { get }\n\n Objective-C \n\n @property (nonatomic, readonly) NSString *_Nonnull OAuthToken;\n\n- `\n ``\n ``\n `\n\n ### [videoStitcherSessionOptions](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)videoStitcherSessionOptions)\n\n `\n ` \n The session options are used to set Video Stitcher-specific parameters\n for this Video Stitcher stream request. \n\n #### Declaration\n\n Swift \n\n var videoStitcherSessionOptions: [String : Any]? { get set }\n\n Objective-C \n\n @property (nonatomic, copy, nullable) NSDictionary\u003cNSString *, id\u003e *videoStitcherSessionOptions;\n\n- `\n ``\n ``\n `\n\n ### [-initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:videoStitcherSessionOptions:](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(im)initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:videoStitcherSessionOptions:)\n\n `\n ` \n Initializes a stream request instance with the given network code and custom\n asset key. Uses the given ad display container to display the stream. \n\n #### Declaration\n\n Swift \n\n init(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken ../Classes/IMAVideoStitcherLiveStreamRequest.html#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: ../Classes/IMAAdDisplayContainer.html, videoDisplay: any ../Protocols/IMAVideoDisplay.html, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)\n\n Objective-C \n\n - (nonnull instancetype)\n initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID\n region:(nonnull NSString *)region\n projectNumber:(nonnull NSString *)projectNumber\n OAuthToken:(nonnull NSString *)OAuthToken\n networkCode:(nonnull NSString *)networkCode\n customAssetKey:(nonnull NSString *)customAssetKey\n adDisplayContainer:\n (nonnull ../Classes/IMAAdDisplayContainer.html *)adDisplayContainer\n videoDisplay:(nonnull id\u003c../Protocols/IMAVideoDisplay.html\u003e)videoDisplay\n userContext:(nullable id)userContext\n videoStitcherSessionOptions:\n (nullable NSDictionary\u003cNSString *, id\u003e *)videoStitcherSessionOptions;\n\n #### Parameters\n\n |-------------------------------------|------------------------------------------------------|\n | ` `*liveStreamEventID*` ` | The live stream ID for the stream. |\n | ` `*region*` ` | The region for the stream. |\n | ` `*projectNumber*` ` | The project number for the stream. |\n | ` `*OAuthToken*` ` | The OAuth Token for the stream. |\n | ` `*networkCode*` ` | The network code for the stream. |\n | ` `*customAssetKey*` ` | The asset key for the stream. |\n | ` `*adDisplayContainer*` ` | The IMAAdDisplayContainer for rendering the ad UI. |\n | ` `*videoDisplay*` ` | The IMAVideoDisplay where the stream will be played. |\n | ` `*userContext*` ` | The user context for tracking requests (optional) |\n | ` `*videoStitcherSessionOptions*` ` | limited set of cloud session overrides (optional) |\n\n #### Return Value\n\n The IMAVideoStitcherLiveStreamRequest instance.\n- `\n ``\n ``\n `\n\n ### [-initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:videoStitcherSessionOptions:](#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(im)initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:videoStitcherSessionOptions:)\n\n `\n ` \n Initializes a stream request instance with the given network code and custom\n asset key. Uses the given ad display container to display the stream. Uses the picture in picture\n proxy to track PIP events. \n\n #### Declaration\n\n Swift \n\n init(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken ../Classes/IMAVideoStitcherLiveStreamRequest.html#/c:objc(cs)IMAVideoStitcherLiveStreamRequest(py)OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: ../Classes/IMAAdDisplayContainer.html, videoDisplay: any ../Protocols/IMAVideoDisplay.html, pictureInPictureProxy: ../Classes/IMAPictureInPictureProxy.html?, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)\n\n Objective-C \n\n - (nonnull instancetype)\n initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID\n region:(nonnull NSString *)region\n projectNumber:(nonnull NSString *)projectNumber\n OAuthToken:(nonnull NSString *)OAuthToken\n networkCode:(nonnull NSString *)networkCode\n customAssetKey:(nonnull NSString *)customAssetKey\n adDisplayContainer:\n (nonnull ../Classes/IMAAdDisplayContainer.html *)adDisplayContainer\n videoDisplay:(nonnull id\u003c../Protocols/IMAVideoDisplay.html\u003e)videoDisplay\n pictureInPictureProxy:\n (nullable ../Classes/IMAPictureInPictureProxy.html *)pictureInPictureProxy\n userContext:(nullable id)userContext\n videoStitcherSessionOptions:\n (nullable NSDictionary\u003cNSString *, id\u003e *)videoStitcherSessionOptions;\n\n #### Parameters\n\n |-------------------------------------|-------------------------------------------------------|\n | ` `*liveStreamEventID*` ` | The live stream ID for the stream. |\n | ` `*region*` ` | The region for the stream. |\n | ` `*projectNumber*` ` | The project number for the stream. |\n | ` `*OAuthToken*` ` | The OAuth Token for the stream. |\n | ` `*networkCode*` ` | The network code for the stream. |\n | ` `*customAssetKey*` ` | The asset key for the stream. |\n | ` `*adDisplayContainer*` ` | The IMAAdDisplayContainer for rendering the ad UI. |\n | ` `*videoDisplay*` ` | The IMAVideoDisplay where the stream will be played. |\n | ` `*pictureInPictureProxy*` ` | The IMAPictureInPictureProxy for tracking PIP events. |\n | ` `*userContext*` ` | The user context for tracking requests (optional) |\n | ` `*videoStitcherSessionOptions*` ` | limited set of cloud session overrides (optional) |\n\n #### Return Value\n\n The IMAVideoStitcherLiveStreamRequest instance."]]
