class ScteMetadataHelpers
package com.turner.top.sdk.common.metadata.helpers
Contains helper methods to filter SCTE metadata.
This class can be referenced via the following alias:
TOP.cues.ScteMetadataHelpers
See:
Static methods
staticcontainsSegmentationType (metadata:ScteMetadata, type:Int):Bool
Determine if a metadata payload has the specified type
Parameters:
metadata | The scte payload to check |
|---|---|
type | The type to check for |
Returns:
true if the payload contains a descriptor of the specified type, false otherwiseSee:
staticgetAiringIdProp (descriptor:ScteSegmentationDescriptor):Null<Int>
Get the airing id of the descriptor
Parameters:
descriptor | The scte segmentation descriptor to retrieve value from |
|---|
Returns:
The airing id value or null
staticgetDurationProp (descriptor:ScteSegmentationDescriptor):Null<Int>
Get the duration of the descriptor
Parameters:
descriptor | The scte segmentation descriptor to retrieve value from |
|---|
Returns:
The descriptor duration or null
staticgetFirstSegmentationDescriptor (metadata:ScteMetadata, ?type:Int):Null<ScteSegmentationDescriptor>
Get the first descriptor on the payload
Parameters:
metadata | The scte payload to get descriptor from |
|---|---|
type | If specified, filter results by type |
Returns:
The first descriptor on the payload or null
See:
staticgetProgramEnd (metadata:ScteMetadata):Null<ScteSegmentationDescriptor>
Get the ScteSegmentationType.Program_End descriptor
Parameters:
metadata | The scte payload to get descriptor from |
|---|
Returns:
The ScteSegmentationType.Program_End type descriptor if it exists or null
See:
staticgetProgramOverlapStart (metadata:ScteMetadata):Null<ScteSegmentationDescriptor>
Get the ScteSegmentationType.Program_Overlap_Start descriptor
Parameters:
metadata | The scte payload to get descriptor from |
|---|
Returns:
The ScteSegmentationType.Program_Overlap_Start type descriptor if it exists or null
See:
staticgetProgramStart (metadata:ScteMetadata):Null<ScteSegmentationDescriptor>
Get the ScteSegmentationType.Program_Start descriptor
Parameters:
metadata | The scte payload to get descriptor from |
|---|
Returns:
The ScteSegmentationType.Program_Start type descriptor if it exists or null
See:
staticgetRegionalBlackoutProp (descriptor:ScteSegmentationDescriptor):Null<Bool>
Get if regional blackouts are enabled for descriptor
Parameters:
descriptor | The scte segmentation descriptor to retrieve value from |
|---|
Returns:
If blackouts are enabled or null
staticgetSegmentationDescriptors (metadata:ScteMetadata, ?type:Int):Array<ScteSegmentationDescriptor>
Get a list of descriptors on the payload
Parameters:
metadata | The scte payload to get descriptors from |
|---|---|
type | If specified, filter results by type |
Returns:
A filtered list of the descriptors on the payload
See:
staticgetTypeIdProp (descriptor:ScteSegmentationDescriptor):Null<Int>
Get the type id of the descriptor
Parameters:
descriptor | The scte segmentation descriptor to retrieve value from |
|---|
Returns:
The type id or null
staticgetWebDeliveryAllowedProp (descriptor:ScteSegmentationDescriptor):Null<Bool>
Get if web delivery is allowed for descriptor
Parameters:
descriptor | The scte segmentation descriptor to retrieve value from |
|---|
Returns:
If web delivery is allowed or null
staticisProgramEnd (metadata:ScteMetadata):Bool
Get if the metadata has descriptor type ScteSegmentationType.Program_End
Parameters:
metadata | The scte payload to check |
|---|
Returns:
true if metadata has descriptor of specified type, false otherwiseSee:
staticisProgramOverlapStart (metadata:ScteMetadata):Bool
Get if the metadata has descriptor type ScteSegmentationType.Program_Overlap_Start
Parameters:
metadata | The scte payload to check |
|---|
Returns:
true if metadata has descriptor of specified type, false otherwiseSee:
staticisProgramStart (metadata:ScteMetadata):Bool
Get if the metadata has descriptor type ScteSegmentationType.Program_Start
Parameters:
metadata | The scte payload to check |
|---|
Returns:
true if metadata has descriptor of specified type, false otherwiseSee: