tv.amwa.maj.iface
Interface GPITrigger

All Superinterfaces:

Component, Event, InterchangeObject, Segment

All Known Implementing Classes:

GPITrigger

public interface GPITrigger
extends Event

Specifies a trigger action that should be taken when the GPI trigger is reached.

A GPI trigger is a one way communication protocol in which the controller tells or "triggers" a video mixer or title generator to perform a previously programmed function such as a transition, effect, or title.

Author:

Richard Cartwright

See Also:

makeGPITrigger()

Method Summary

boolean	getActiveState() Returns the active state of this GPI trigger, which is true if the event is "on".
void	setActiveState(boolean activeState) Set to true to turn the trigger "on" or false to turn the trigger off.

Methods inherited from interface tv.amwa.maj.iface.Event

getComment, getPosition, setComment, setPosition

Methods inherited from interface tv.amwa.maj.iface.Segment

segmentOffsetToTC, segmentTCToOffset

Methods inherited from interface tv.amwa.maj.iface.Component

appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getActiveState

@Bool
boolean getActiveState()

Returns the active state of this GPI trigger, which is true if the event is "on".

Returns:

Active state of this trigger.

setActiveState

void setActiveState(@Bool
                    boolean activeState)

Set to true to turn the trigger "on" or false to turn the trigger off.

Parameters:

activeState - Active state to set for the trigger.