| Package | com.adobe.mediacore.utils.scte35.data |
| Class | public class SpliceCommandData |
| Inheritance | SpliceCommandData  Object |
| Subclasses | SpliceInsertCommand |
| Property | Defined By | ||
|---|---|---|---|
| availExpected : uint [read-only]
This field provides a count of the expected number of individual avails within the
current viewing event. | SpliceCommandData | ||
| availNum : uint [read-only]
This field provides an identification for a specific avail within the program. | SpliceCommandData | ||
| breakDuration : BreakDuration [read-only]
Break duration information. | SpliceCommandData | ||
| cancelEvent : Boolean [read-only]
A boolean flag that when set to ‘true’ indicates that a previously sent splice
event, identified by eventId, has been cancelled. | SpliceCommandData | ||
| components : Vector.<SpliceComponent> [read-only]
Program components which will be spliced. | SpliceCommandData | ||
| durationIsSpecified : Boolean [read-only]
Flag indicating that the duration of the break is known in advance. | SpliceCommandData | ||
| eventId : Number [read-only]
Splice event identifier. | SpliceCommandData | ||
| outOfNetwork : Boolean [read-only]
A boolean flag indicating the type of this splice event. | SpliceCommandData | ||
| spliceEntireProgram : Boolean [read-only]
Flag indicating if the entire program should be spliced or just specified components
When set to ‘true’, indicates that the message refers to a Program Splice Point and that
the mode is the Program Splice Mode whereby all PIDs/components of the program are to be
spliced. | SpliceCommandData | ||
| spliceImmediate : Boolean [read-only]
Flag indicating that the splice event should happen immediately. | SpliceCommandData | ||
| spliceTime : SpliceTime [read-only]
Specifies the time of the splice event. | SpliceCommandData | ||
| uniqueProgramId : uint [read-only]
This value should provide a unique identification for a viewing event
within the service. | SpliceCommandData | ||
| Method | Defined By | ||
|---|---|---|---|
SpliceCommandData(eventId:Number, cancelEvent:Boolean, outOfNetwork:Boolean, spliceImmediate:Boolean, spliceTime:SpliceTime, spliceEntireProgram:Boolean, components:Vector.<SpliceComponent>, durationIsSpecified:Boolean, breakDuration:BreakDuration, uniqueProgramId:uint, availNum:uint, availExpected:uint)
Default constructor. | SpliceCommandData | ||
| availExpected | property |
availExpected:uint [read-only] This field provides a count of the expected number of individual avails within the current viewing event. When this field is zero, it indicates that the avail field has no meaning.
public function get availExpected():uint| availNum | property |
availNum:uint [read-only] This field provides an identification for a specific avail within the program. This value is expected to increment with each new avail within a viewing event. This value is expected to reset to one for the first avail in a new viewing event. This field is expected to increment for each new avail. It may optionally carry a zero value to indicate its non-usage.
public function get availNum():uint| breakDuration | property |
breakDuration:BreakDuration [read-only] Break duration information.
public function get breakDuration():BreakDurationSee also
| cancelEvent | property |
cancelEvent:Boolean [read-only] A boolean flag that when set to ‘true’ indicates that a previously sent splice event, identified by eventId, has been cancelled.
public function get cancelEvent():Boolean| components | property |
components:Vector.<SpliceComponent> [read-only] Program components which will be spliced. When the mode is Program Splice Mode, then this vector will be empty. Otherwise the vector will contain the stream components which need to be spliced.
public function get components():Vector.<SpliceComponent>| durationIsSpecified | property |
durationIsSpecified:Boolean [read-only] Flag indicating that the duration of the break is known in advance.
public function get durationIsSpecified():Boolean| eventId | property |
eventId:Number [read-only] Splice event identifier.
public function get eventId():Number| outOfNetwork | property |
outOfNetwork:Boolean [read-only] A boolean flag indicating the type of this splice event. When set to ‘true’, indicates that the splice event is an opportunity to exit from the network feed and that the value of spliceTime shall refer to an intended Out Point or Program Out Point. When set to ‘false’, the flag indicates that the splice event is an opportunity to return to the network feed and that the value of spliceTime shall refer to an intended In Point or Program In Point.
public function get outOfNetwork():Boolean| spliceEntireProgram | property |
spliceEntireProgram:Boolean [read-only] Flag indicating if the entire program should be spliced or just specified components When set to ‘true’, indicates that the message refers to a Program Splice Point and that the mode is the Program Splice Mode whereby all PIDs/components of the program are to be spliced. When set to ‘false’, this field indicates that the mode is the Component Splice Mode whereby each component that is intended to be spliced will be listed separately in the components property.
public function get spliceEntireProgram():Boolean| spliceImmediate | property |
spliceImmediate:Boolean [read-only] Flag indicating that the splice event should happen immediately. When this flag is ‘true’, it indicates the absence of the spliceTime property and that the splice mode shall be the Splice Immediate Mode, whereby the splicing device shall choose the nearest opportunity in the stream, relative to the splice information packet, to splice. When this flag is ‘false’, it indicates that the spliceTime property is explicitly set at program or component level.
public function get spliceImmediate():Boolean| spliceTime | property |
spliceTime:SpliceTime [read-only] Specifies the time of the splice event.
public function get spliceTime():SpliceTimeSee also
| uniqueProgramId | property |
uniqueProgramId:uint [read-only] This value should provide a unique identification for a viewing event within the service. Note: See SCTE 118-2 for guidance in setting values for this field.
public function get uniqueProgramId():uint| SpliceCommandData | () | Constructor |
public function SpliceCommandData(eventId:Number, cancelEvent:Boolean, outOfNetwork:Boolean, spliceImmediate:Boolean, spliceTime:SpliceTime, spliceEntireProgram:Boolean, components:Vector.<SpliceComponent>, durationIsSpecified:Boolean, breakDuration:BreakDuration, uniqueProgramId:uint, availNum:uint, availExpected:uint)Default constructor.
ParameterseventId:Number — Event unique identifier.
| |
cancelEvent:Boolean — Flag indicating if the event was canceled or not.
| |
outOfNetwork:Boolean — Flag indicating if the splice event is an opportunity
to exit from or to return to the network feed.
| |
spliceImmediate:Boolean — Flag indicating that the splice event should happen immediately.
| |
spliceTime:SpliceTime — Time information where the splice event should occur.
| |
spliceEntireProgram:Boolean — Flag indicating if the entire program should be spliced or
just specified components.
| |
components:Vector.<SpliceComponent> — Program components which will be spliced.
| |
durationIsSpecified:Boolean — Flag indicating that the duration of the break is known in advance.
| |
breakDuration:BreakDuration — Duration of the break.
| |
uniqueProgramId:uint — Unique current viewing event identifier.
| |
availNum:uint — The identification for a specific avail within the current viewing event.
| |
availExpected:uint — The count of the expected number of individual avails within the
current viewing event.
|