Packagecom.adobe.mediacore.utils.scte35.commands
Classpublic final class SpliceInsertCommand
InheritanceSpliceInsertCommand Inheritance SpliceCommandData Inheritance Object
Implements SpliceCommand

Splice command instructs the application to execute a splice event. The SpliceInsert command shall be sent at least once before each splice point. In order to give advance warning of the impending splice (a pre-roll function), the SpliceInsert command could be sent multiple times before the splice point. For example, the SpliceInsert command could be sent at 8, 5, 4 and 2 seconds prior to the packet containing the related splice point. In order to meet other splicing deadlines in the system, any message received with less then 4 seconds of advance notice may not create the desired result. The SpliceInsert message shall be sent at least once a minimum of 4 seconds in advance of the desired splice time for a network Out Point condition. It is recommended that, if a return-to-network (an In Point) message is sent, the same minimum 4 second pre-roll be provided. The SpliceInsert command provides for an optional breakDuration property to identify the length of the commercial break. It is recommended that SpliceInsert messages with the outOfNetwork property set to true (a network Out Point) include a breakDuration structure to provide the application with an indication of when the network In Point will occur. The BreakDuration structure provides for an optional autoReturn property that, when set to true, indicates that the application is to return to the network at the end of the break (defined as Auto Return Mode, refer to Section 7.5.2.2). It is recommended that this Auto Return Mode be used to support dynamic avail durations.



Public Properties
 PropertyDefined By
 InheritedavailExpected : uint
[read-only] This field provides a count of the expected number of individual avails within the current viewing event.
SpliceCommandData
 InheritedavailNum : uint
[read-only] This field provides an identification for a specific avail within the program.
SpliceCommandData
 InheritedbreakDuration : BreakDuration
[read-only] Break duration information.
SpliceCommandData
 InheritedcancelEvent : 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
 Inheritedcomponents : Vector.<SpliceComponent>
[read-only] Program components which will be spliced.
SpliceCommandData
 InheriteddurationIsSpecified : Boolean
[read-only] Flag indicating that the duration of the break is known in advance.
SpliceCommandData
 InheritedeventId : Number
[read-only] Splice event identifier.
SpliceCommandData
 InheritedoutOfNetwork : Boolean
[read-only] A boolean flag indicating the type of this splice event.
SpliceCommandData
 InheritedspliceEntireProgram : 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
 InheritedspliceImmediate : Boolean
[read-only] Flag indicating that the splice event should happen immediately.
SpliceCommandData
 InheritedspliceTime : SpliceTime
[read-only] Specifies the time of the splice event.
SpliceCommandData
  type : uint
[read-only] Returns the type of the splice command.
SpliceInsertCommand
 InheriteduniqueProgramId : uint
[read-only] This value should provide a unique identification for a viewing event within the service.
SpliceCommandData
Public Methods
 MethodDefined By
  
SpliceInsertCommand(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.
SpliceInsertCommand
Property Detail
typeproperty
type:uint  [read-only]

Returns the type of the splice command. See the SpliceCommandType enumeration for possible values.


Implementation
    public function get type():uint
Constructor Detail
SpliceInsertCommand()Constructor
public function SpliceInsertCommand(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.

Parameters
eventId: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.