IAAFGPITrigger Interface Reference

The IAAFGPITrigger interface is implemented by objects which represent an trigger action that should be taken when its position in time is reached. More...

List of all members.

Public Member Functions
HRESULT	GetActiveState ([out, retval] aafBoolean_t *pActiveState)
	Sets *pActiveState to AAFTrue it the event is on otherwise sets it to AAFFalse.
HRESULT	SetActiveState ([in] aafBoolean_t ActiveState)
	Set to AAFTrue to turn the trigger on or AAFFalse to turn the trigger off.

---

Detailed Description

The IAAFGPITrigger interface is implemented by objects which represent an trigger action that should be taken when its position in time is reached.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

• insufficient system memory is available to perform the operation.

AAFRESULT_NOT_INITIALIZED

• This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFMobSlot is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface.

Objects that implement IAAFGPITrigger also implement the following interfaces:

• IAAFEvent
• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 10874 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFGPITrigger::GetActiveState

(

[out, retval] aafBoolean_t *

pActiveState

)

Sets *pActiveState to AAFTrue it the event is on otherwise sets it to AAFFalse.

Succeeds if:

• The pActiveState pointer is valid.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

• The pActiveState pointer is NULL.

Parameters:

pActiveState

[out, retval] pointer to the result

HRESULT IAAFGPITrigger::SetActiveState

(

[in] aafBoolean_t

ActiveState

)

Set to AAFTrue to turn the trigger on or AAFFalse to turn the trigger off.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

• succeeded. (This is the only code indicating success.)

Parameters:

ActiveState

[in] the active state of the trigger