GoogleInteractiveMediaAds Framework Reference

  • IMAVODStreamRequest is a data object used for describing a Video On Demand (VOD) stream request.

  • It includes properties like contentSourceID to identify the content source and videoID to specify the video to be played.

  • The class offers multiple initialization methods for creating a stream request instance, some of which are deprecated in favor of newer versions that include a networkCode parameter.

  • Initialization methods require parameters such as the content source and video IDs, an ad display container for ad rendering, and a video display for stream playback, with optional parameters like network code, picture-in-picture proxy, and user context.

IMAVODStreamRequest

@interface IMAVODStreamRequest : IMAStreamRequest

Data object describing a VOD stream request.

  • The stream request content source ID. This is used to determine the content source of the stream.

    Declaration

    Swift

    var contentSourceID: String { get }

    Objective-C

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

  • The stream request video ID. This is used to determine which specific video stream should be played.

    Declaration

    Swift

    var videoID: String { get }

    Objective-C

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

  • Initializes a stream request instance with the given content source ID and video ID. Uses the given ad display container to display the stream. This is used for on-demand streams.

    Declaration

    Swift

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

    Objective-C

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

    Parameters

    contentSourceID

    the content source ID for this stream
    videoID

    the video identifier for this stream
    networkCode

    the network code for the stream (optional but recommended).
    adDisplayContainer

    the IMAAdDisplayContainer for rendering the ad UI
    videoDisplay

    the IMAVideoDisplay for playing the stream
    userContext

    The user context for tracking requests (optional)

    Return Value

    the IMAVODStreamRequest instance

  • Initializes a stream request instance with the given content source ID and video ID. Uses the given ad display container to display the stream. This is used for on-demand streams. Uses the picture in picture proxy to track PIP events.

    Declaration

    Swift

    init(contentSourceID: String, videoID: String, networkCode: String?, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?)

    Objective-C

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

    Parameters

    contentSourceID

    the content source ID for this stream
    videoID

    the video identifier for this stream
    networkCode

    the network code for the stream (optional but recommended).
    adDisplayContainer

    the IMAAdDisplayContainer for rendering the ad UI
    videoDisplay

    the IMAVideoDisplay for playing the stream
    pictureInPictureProxy

    the IMAPictureInPictureProxy for tracking PIP events
    userContext

    The user context for tracking requests (optional)

    Return Value

    the IMAVODStreamRequest instance

  • Deprecated

    Use contentSourceID:videoId:networkCode:adDisplayContainer:videoDisplay:userContext: instead.

    Initializes a stream request instance with the given content source ID and video ID. Uses the given ad display container to display the stream. This is used for on-demand streams.

    Declaration

    Swift

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

    Objective-C

    - (nonnull instancetype)
    initWithContentSourceID:(nonnull NSString *)contentSourceID
                    videoID:(nonnull NSString *)videoID
         adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
               videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
                userContext:(nullable id)userContext;

    Parameters

    contentSourceID

    the content source ID for this stream
    videoID

    the video identifier for this stream
    adDisplayContainer

    the IMAAdDisplayContainer for rendering the ad UI
    videoDisplay

    the IMAVideoDisplay for playing the stream
    userContext

    The user context for tracking requests (optional)

    Return Value

    the IMAVODStreamRequest instance

  • Deprecated

    Use initWithContentSourceID:videoID:networkCode:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext: instead.

    Initializes a stream request instance with the given content source ID and video ID. Uses the given ad display container to display the stream. This is used for on-demand streams. Uses the picture in picture proxy to track PIP events.

    Declaration

    Swift

    init(contentSourceID: String, videoID: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?)

    Objective-C

    - (nonnull instancetype)
    initWithContentSourceID:(nonnull NSString *)contentSourceID
                    videoID:(nonnull NSString *)videoID
         adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer
               videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
      pictureInPictureProxy:
          (nullable IMAPictureInPictureProxy *)pictureInPictureProxy
                userContext:(nullable id)userContext;

    Parameters

    contentSourceID

    the content source ID for this stream
    videoID

    the video identifier for this stream
    adDisplayContainer

    the IMAAdDisplayContainer for rendering the ad UI
    videoDisplay

    the IMAVideoDisplay for playing the stream
    pictureInPictureProxy

    the IMAPictureInPictureProxy for tracking PIP events
    userContext

    The user context for tracking requests (optional)

    Return Value

    the IMAVODStreamRequest instance