GoogleInteractiveMediaAds Framework Reference | IMA SDK for iOS


                    
                    
                    liveStreamEventID

The live stream ID for the stream.

Declaration

Swift

var liveStreamEventID: String { get }

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull liveStreamEventID;


                    
                    
                    region

The region for the stream.

Declaration

Swift

var region: String { get }

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull region;


                    
                    
                    projectNumber

The project number for the stream.

Declaration

Swift

var projectNumber: String { get }

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull projectNumber;


                    
                    
                    OAuthToken

The OAuth Token for the stream.

Declaration

Swift

var oAuthToken: String { get }

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull OAuthToken;


                    
                    
                    videoStitcherSessionOptions

The session options are used to set Video Stitcher-specific parameters for this Video Stitcher stream request.

Declaration

Swift

var videoStitcherSessionOptions: [String : Any]? { get set }

Objective-C

@property (nonatomic, copy, nullable) NSDictionary<NSString *, id> *videoStitcherSessionOptions;


                    
                    
                    -initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:userContext:videoStitcherSessionOptions:

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(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: IMAVideoDisplay, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

Objective-C

- (nonnull instancetype)
      initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID
                         region:(nonnull NSString *)region
                  projectNumber:(nonnull NSString *)projectNumber
                     OAuthToken:(nonnull NSString *)OAuthToken
                    networkCode:(nonnull NSString *)networkCode
                 customAssetKey:(nonnull NSString *)customAssetKey
             adDisplayContainer:
                 (nonnull IMAAdDisplayContainer *)adDisplayContainer
                   videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
                    userContext:(nullable id)userContext
    videoStitcherSessionOptions:
        (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

Parameters

`liveStreamEventID`	The live stream ID for the stream.
`region`	The region for the stream.
`projectNumber`	The project number for the stream.
`OAuthToken`	The OAuth Token for the stream.
`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)
`videoStitcherSessionOptions`	limited set of cloud session overrides (optional)

Return Value

The IMAVideoStitcherLiveStreamRequest instance.


                    
                    
                    -initWithLiveStreamEventID:region:projectNumber:OAuthToken:networkCode:customAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:userContext:videoStitcherSessionOptions:

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(liveStreamEventID: String, region: String, projectNumber: String, oAuthToken OAuthToken: String, networkCode: String, customAssetKey: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?, videoStitcherSessionOptions: [String : Any]? = nil)

Objective-C

- (nonnull instancetype)
      initWithLiveStreamEventID:(nonnull NSString *)liveStreamEventID
                         region:(nonnull NSString *)region
                  projectNumber:(nonnull NSString *)projectNumber
                     OAuthToken:(nonnull NSString *)OAuthToken
                    networkCode:(nonnull NSString *)networkCode
                 customAssetKey:(nonnull NSString *)customAssetKey
             adDisplayContainer:
                 (nonnull IMAAdDisplayContainer *)adDisplayContainer
                   videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay
          pictureInPictureProxy:
              (nullable IMAPictureInPictureProxy *)pictureInPictureProxy
                    userContext:(nullable id)userContext
    videoStitcherSessionOptions:
        (nullable NSDictionary<NSString *, id> *)videoStitcherSessionOptions;

Parameters

`liveStreamEventID`	The live stream ID for the stream.
`region`	The region for the stream.
`projectNumber`	The project number for the stream.
`OAuthToken`	The OAuth Token for the stream.
`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)
`videoStitcherSessionOptions`	limited set of cloud session overrides (optional)

Return Value

The IMAVideoStitcherLiveStreamRequest instance.