GoogleInteractiveMediaAds Framework Reference

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;
  • Initializes a live stream request instance with the given assetKey. Uses the given ad display container to display the stream.

    Declaration

    Objective-C

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

    Parameters

    assetKey

    the stream assetKey

    adDisplayContainer

    the IMAAdDisplayContainer for rendering the ad UI

    videoDisplay

    the IMAVideoDisplay for playing the stream

    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

    Objective-C

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

    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

    Return Value

    the IMALiveStreamRequest instance