GoogleInteractiveMediaAds Framework Reference

  • The IMALiveStreamRequest is a data object used to describe a live stream request, inheriting from IMAStreamRequest.

  • The assetKey is a required identifier found in the DFP UI that determines which live stream should be played.

  • There are multiple initializers for IMALiveStreamRequest, allowing for the specification of asset key, network code, ad display container, video display, picture-in-picture proxy, and user context.

  • Deprecated initializers exist and should be replaced with those that include the network code parameter.

IMALiveStreamRequest

@interface IMALiveStreamRequest : IMAStreamRequest

Data object describing a live stream request.

  • This is used to determine which stream should be played. The live stream request asset key is an identifier which can be found in the DFP UI.

    @type {!string}

    Declaration

    Swift

    var assetKey: String { get }

    Objective-C

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

  • Specifies whether to use HLS interstitials for this stream. This will request that DAI use HLS interstitials, or return an error if interstitials are not supported. If IMAAVPlayerVideoDisplay is used in the stream request, the SDK will perform a compatibility check to ensure the device can handle HLS interstitial playback, and will throw an error at request time otherwise. If a custom video display is used, the compatibility check will not be performed.

    Declaration

    Swift

    var useHLSInterstitials: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL useHLSInterstitials;

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

    Declaration

    Swift

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

    Objective-C

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

    Parameters

    assetKey

    the stream assetKey
    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 IMALiveStreamRequest instance

  • Initializes a live stream request instance with the given assetKey. Uses the given ad display container to display the stream. Uses the picture in picture proxy to track PIP events.

    Declaration

    Swift

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

    Objective-C

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

    Parameters

    assetKey

    the stream assetKey
    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 IMALiveStreamRequest instance

  • Deprecated

    Use initWithAssetKey:networkCode:adDisplayContainer:videoDisplay:userContext: instead.

    Initializes a live stream request instance with the given assetKey. Uses the given ad display container to display the stream.

    Declaration

    Swift

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

    Objective-C

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

    Parameters

    assetKey

    the stream assetKey
    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 IMALiveStreamRequest instance

  • Deprecated

    Use initWithAssetKey:networkCode:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext: instead.

    Initializes a live stream request instance with the given assetKey. Uses the given ad display container to display the stream. Uses the picture in picture proxy to track PIP events.

    Declaration

    Swift

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

    Objective-C

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

    Parameters

    assetKey

    the stream assetKey
    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 IMALiveStreamRequest instance