GoogleInteractiveMediaAds Framework Reference

  • IMAPodVODStreamRequest is a data object for requesting a third-party stitched server-side ad insertion pod serving VOD stream.

  • The class has two initialization methods, both requiring a network code, ad display container, and video display.

  • One initialization method includes an optional picture in picture proxy parameter for tracking PIP events.

  • Both initialization methods return an instance of the IMAPodVODStreamRequest.

IMAPodVODStreamRequest

@interface IMAPodVODStreamRequest : IMAStreamRequest

Data object describing a stream request for a third party stitched server-side ad insertion pod serving VOD stream.

  • Initializes a stream request instance with the given network. Uses the given ad display container to display the stream.

    Declaration

    Swift

    init(networkCode: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?)

    Objective-C

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

    Parameters

    networkCode

    The network code 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 IMAPodVODStreamRequest instance.

  • Initializes a stream request instance with the given network code. 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, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?)

    Objective-C

    - (nonnull instancetype)
      initWithNetworkCode:(nonnull NSString *)networkCode
       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.
    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 IMAPodVODStreamRequest instance.