GoogleInteractiveMediaAds Framework Reference

IMAVideoStitcherVODStreamRequest

@interface IMAVideoStitcherVODStreamRequest : IMAStreamRequest

Data object describing a stream request for a Google video stitcher video on demand serving stream.

• adTagURL

  The adTagURL for the stream.

  Declaration

  Swift

  var adTagURL: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *adTagURL;

• contentSourceURL

  The URL of the content source for the stream.

  Declaration

  Swift

  var contentSourceURL: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *contentSourceURL;

• OAuthToken

  The OAuth Token for the stream.

  Declaration

  Swift

  var oAuthToken: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull OAuthToken;

• projectNumber

  The project number for the stream.

  Declaration

  Swift

  var projectNumber: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull projectNumber;

• region

  The region for the stream.

  Declaration

  Swift

  var region: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull region;

• VODConfigID

  The VOD Config ID for the stream.

  Declaration

  Swift

  var vodConfigID: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *VODConfigID;

• videoStitcherSessionOptions

  The session options are used to set Video Stitcher-specific parameters for this request.

  Declaration

  Swift

  var videoStitcherSessionOptions: [String : Any]? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSDictionary<NSString *, id> *videoStitcherSessionOptions;

• -initWithAdTagURL:region:projectNumber:OAuthToken:networkCode:contentSourceURL:adDisplayContainer:videoDisplay:userContext:videoStitcherSessionOptions:

  Initializes a stream request instance with the given network code, content source url, ad tag url, project number, region, and OAuth token. Uses the given ad display container to display the stream.

  Declaration

  Swift

  init(adTagURL: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, contentSourceURL: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

  Objective-C

  - (nonnull instancetype)
                 initWithAdTagURL:(nonnull NSString *)adTagURL
                           region:(nonnull NSString *)region
                    projectNumber:(nonnull NSString *)projectNumber
                       OAuthToken:(nonnull NSString *)OAuthToken
                      networkCode:(nonnull NSString *)networkCode
                 contentSourceURL:(nonnull NSString *)contentSourceURL
               adDisplayContainer:
                   (nonnull IMAAdDisplayContainer *)adDisplayContainer
                     videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
                      userContext:(nullable id)userContext
      videoStitcherSessionOptions:
          (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

  Parameters

  adTagURL	The adTagURL for the stream.
  contentSourceURL	The contentSourceURL for the stream.
  networkCode	The networkCode for the stream.
  OAuthToken	The OAuth token for the stream.
  projectNumber	The projectNumber for the stream.
  region	The region 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 IMAVideoStitcherVODStreamRequest instance.

• -initWithAdTagURL:region:projectNumber:OAuthToken:networkCode:contentSourceURL:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:videoStitcherSessionOptions:

  Initializes a stream request instance with the given network code, content source url, ad tag url, project number, region, and OAuth token. Uses the given ad display container to display the stream. Uses the picture in picture proxy to track PIP events.

  Declaration

  Swift

  init(adTagURL: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, contentSourceURL: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

  Objective-C

  - (nonnull instancetype)
                 initWithAdTagURL:(nonnull NSString *)adTagURL
                           region:(nonnull NSString *)region
                    projectNumber:(nonnull NSString *)projectNumber
                       OAuthToken:(nonnull NSString *)OAuthToken
                      networkCode:(nonnull NSString *)networkCode
                 contentSourceURL:(nonnull NSString *)contentSourceURL
               adDisplayContainer:
                   (nonnull IMAAdDisplayContainer *)adDisplayContainer
                     videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
            pictureInPictureProxy:
                (nullable IMAPictureInPictureProxy *)pictureInPictureProxy
                      userContext:(nullable id)userContext
      videoStitcherSessionOptions:
          (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

  Parameters

  adTagURL	The adTagURL code for the stream.
  contentSourceURL	The contentSourceURL code for the stream.
  networkCode	The networkCode for the stream.
  OAuthToken	The OAuth Token for the stream.
  projectNumber	The projectNumber for the stream.
  region	The region 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 IMAVideoStitcherVODStreamRequest instance.

• -initWithVODConfigID:region:projectNumber:OAuthToken:networkCode:adDisplayContainer:videoDisplay:userContext:videoStitcherSessionOptions:

  Initializes a stream request instance with the given network code, vod config ID, project number, region, and OAuth token. Uses the given ad display container to display the stream.

  Declaration

  Swift

  init(vodConfigID VODConfigID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

  Objective-C

  - (nonnull instancetype)
              initWithVODConfigID:(nonnull NSString *)VODConfigID
                           region:(nonnull NSString *)region
                    projectNumber:(nonnull NSString *)projectNumber
                       OAuthToken:(nonnull NSString *)OAuthToken
                      networkCode:(nonnull NSString *)networkCode
               adDisplayContainer:
                   (nonnull IMAAdDisplayContainer *)adDisplayContainer
                     videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
                      userContext:(nullable id)userContext
      videoStitcherSessionOptions:
          (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

  Parameters

  VODConfigID	The VOD Config ID for the stream from cloud stitcher.
  networkCode	The networkCode for the stream.
  OAuthToken	The OAuth token for the stream.
  projectNumber	The projectNumber for the stream.
  region	The region 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 IMAVideoStitcherVODStreamRequest instance.

• -initWithVODConfigID:region:projectNumber:OAuthToken:networkCode:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:videoStitcherSessionOptions:

  Initializes a stream request instance with the given network code, vod config ID, project number, region, and OAuth token. Uses the given ad display container to display the stream. Uses the picture in picture proxy to track PIP events.

  Declaration

  Swift

  init(vodConfigID VODConfigID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

  Objective-C

  - (nonnull instancetype)
              initWithVODConfigID:(nonnull NSString *)VODConfigID
                           region:(nonnull NSString *)region
                    projectNumber:(nonnull NSString *)projectNumber
                       OAuthToken:(nonnull NSString *)OAuthToken
                      networkCode:(nonnull NSString *)networkCode
               adDisplayContainer:
                   (nonnull IMAAdDisplayContainer *)adDisplayContainer
                     videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
            pictureInPictureProxy:
                (nullable IMAPictureInPictureProxy *)pictureInPictureProxy
                      userContext:(nullable id)userContext
      videoStitcherSessionOptions:
          (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

  Parameters

  VODConfigID	The VOD Config ID for the stream from cloud stitcher.
  networkCode	The networkCode for the stream.
  OAuthToken	The OAuth Token for the stream.
  projectNumber	The projectNumber for the stream.
  region	The region 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 IMAVideoStitcherVODStreamRequest instance.