VerizonMediaSource Class Reference


                    
                    
                    integration

The integration ID of the source.

Declaration

Swift

public private(set) var integration: SourceIntegration { get }


                    
                    
                    assetIds

One or multiple asset identifiers for the source.

Remark

The order of a list of asset identifiers is the order their corresponding assets will be played in.

Declaration

Swift

public private(set) var assetIds: [VerizonMediaAssetId]? { get }


                    
                    
                    externalId

The external identifier used by Verizon Media.

Declaration

Swift

public private(set) var externalId: VerizonMediaExternalId? { get }


                    
                    
                    parameters

A record of query string parameters added to Verizon Media Preplay requests.

Remark

Each entry contains the parameter’s name with associated value.
Does not maintain the order of the parameters, if the order is important then use the VerizonMediaSource.orderedParameters property instead.

Declaration

Swift

public private(set) var parameters: Dictionary<String, String>? { get }


                    
                    
                    orderedParameters

An array of ordered query string parameters added to Verizon Media Preplay requests.

Remark

Each entry contains the parameter’s name with associated value.
Maintains the order of the parameters. It will override VerizonMediaSource.parameters internally if both aren’t nil.

Declaration

Swift

public private(set) var orderedParameters: Array<(String, String)>? { get }


                    
                    
                    playbackUrlParameters

The query string parameters added to Verizon Media playback URL requests.

Remark

Each entry contains the parameter’s name with associated value.
Valid parameters:
- Uplynk Playback Customization parameters: https://docs.vdms.com/video/#Setup/Customizing-Playback.htm
- Uplynk Tokens parameters: https://docs.vdms.com/video/#Setup/Playback-URLs.htm

Declaration

Swift

public private(set) var playbackUrlParameters: Dictionary<String, String>? { get }


                    
                    
                    assetType

The content type of the asset, defaults to VerizonMediaAssetType.ASSET.

Declaration

Swift

public private(set) var assetType: VerizonMediaAssetType? { get }


                    
                    
                    contentProtected

When enabled, the necessary content protection configuration will be added to the source, defaults to false.

Declaration

Swift

public private(set) var contentProtected: Bool? { get }


                    
                    
                    ping

The configuration for using the Ping API for SSAI tracking and updates in live streams.

Declaration

Swift

public private(set) var ping: VerizonMediaPingConfiguration? { get }


                    
                    
                    prefix

The prefix to use for Verizon Media Preplay API and Asset Info API requests.

Declaration

Swift

public private(set) var prefix: String? { get }


                    
                    
                    init(assetId:parameters:orderedParameters:playbackUrlParameters:assetType:contentProtected:ping:prefix:)

Constructs a Verizon Media Source.

Declaration

Swift

public convenience init(assetId: VerizonMediaAssetId, parameters: Dictionary<String, String>? = nil, orderedParameters: Array<(String, String)>? = nil, playbackUrlParameters: Dictionary<String, String>? = nil, assetType: VerizonMediaAssetType? = VerizonMediaAssetType.ASSET, contentProtected: Bool? = false, ping: VerizonMediaPingConfiguration? = nil, prefix: String? = nil)

Parameters

`assetId`	A Verizon Media asset.
`parameters`	A dictionary of query string parameters added to Verizon Media Preplay requests, defaults to nil.
`orderedParameters`	An array of ordered query string parameters added to Verizon Media Preplay requests, defaults to nil.
`assetType`	The content type of the asset, defaults to `VerizonMediaAssetType.ASSET`.
`contentProtected`	Whether the asset is content protected, defaults to false.
`ping`	The Ping Configuration, defaults to nil.
`prefix`	The prefix to use for Verizon Media Preplay API and Asset Info API requests, defaults to `'https://content.uplynk.com'`


                    
                    
                    init(assetIds:parameters:orderedParameters:playbackUrlParameters:assetType:contentProtected:ping:prefix:)

Constructs a Verizon Media Source.

Declaration

Swift

public convenience init(assetIds: [VerizonMediaAssetId], parameters: Dictionary<String, String>? = nil, orderedParameters: Array<(String, String)>? = nil, playbackUrlParameters: Dictionary<String, String>? = nil, assetType: VerizonMediaAssetType? = VerizonMediaAssetType.ASSET, contentProtected: Bool? = false, ping: VerizonMediaPingConfiguration? = nil, prefix: String? = nil)

Parameters

`assetIds`	A list of Verizon Media asset identifiers.
`parameters`	A dictionary of query string parameters added to Verizon Media Preplay requests, defaults to nil.
`orderedParameters`	An array of ordered query string parameters added to Verizon Media Preplay requests, defaults to nil.
`assetType`	The content type of the asset, defaults to `VerizonMediaAssetType.ASSET`.
`contentProtected`	Whether the asset is content protected, defaults to false.
`ping`	The Ping Configuration, defaults to nil.
`prefix`	The prefix to use for Verizon Media Preplay API and Asset Info API requests, defaults to `'https://content.uplynk.com'`


                    
                    
                    init(externalId:parameters:orderedParameters:playbackUrlParameters:assetType:contentProtected:ping:prefix:)

Constructs a Verizon Media Source.

Declaration

Swift

public convenience init(externalId: VerizonMediaExternalId, parameters: Dictionary<String, String>? = nil, orderedParameters: Array<(String, String)>? = nil, playbackUrlParameters: Dictionary<String, String>? = nil, assetType: VerizonMediaAssetType? = VerizonMediaAssetType.ASSET, contentProtected: Bool? = false, ping: VerizonMediaPingConfiguration? = nil, prefix: String? = nil)

Parameters

`externalId`	An external identifier of Verizon Media.
`parameters`	A dictionary of query string parameters added to Verizon Media requests, defaults to nil.
`orderedParameters`	An array of ordered query string parameters added to Verizon Media Preplay requests, defaults to nil.
`assetType`	The content type of the asset, defaults to `VerizonMediaAssetType.ASSET` .
`contentProtected`	Whether the asset is content protected, defaults to `false`.
`ping`	The Ping Configuration, defaults to nil.
`prefix`	The prefix to use for Verizon Media Preplay API and Asset Info API requests, defaults to `'https://content.uplynk.com'`