GoogleInteractiveMediaAds Framework Reference

AI-generated Key Takeaways

• IMAPodStreamRequest is a data object that encapsulates the information needed to request a stream from a pod serving system.

• It requires a network code and a custom asset key to identify the stream.

• The request object utilizes IMAAdDisplayContainer for ad UI rendering and IMAVideoDisplay for stream playback.

• Initialization can optionally include a IMAPictureInPictureProxy for Picture-in-Picture event tracking and user context data.

IMAPodStreamRequest

@interface IMAPodStreamRequest : IMAStreamRequest

Data object describing a stream request for a pod serving stream.

• customAssetKey

  The custom asset key for the stream request.

  Declaration

  Swift

  var customAssetKey: String { get }

  Objective-C

  @property (nonatomic, copy, readonly) NSString *_Nonnull customAssetKey;

• -initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:

  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(networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?)

  Objective-C

  - (nonnull instancetype)
      initWithNetworkCode:(nonnull NSString *)networkCode
           customAssetKey:(nonnull NSString *)customAssetKey
       adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
             videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
              userContext:(nullable id)userContext;

  Parameters

  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)

  Return Value

  The IMAPodStreamRequest instance.

• -initWithNetworkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:

  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(networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?)

  Objective-C

  - (nonnull instancetype)
        initWithNetworkCode:(nonnull NSString *)networkCode
             customAssetKey:(nonnull NSString *)customAssetKey
         adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
               videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
      pictureInPictureProxy:
          (nullable IMAPictureInPictureProxy *)pictureInPictureProxy
                userContext:(nullable id)userContext;

  Parameters

  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)

  Return Value

  The IMAPodStreamRequest instance.