Instance Method

getFloatValue:fromParm:atFxTime:

Retrieves the floating point value of the specified parameter.

Required.

Declaration

- (BOOL)getFloatValue:(double *)value fromParm:(UInt32)parmId atFxTime:(FxTime)time;

Parameters

value

Receives the value of the parameter at the given time.

parmId

ID of the parameter whose value is to be retrieved.

time

Time, expressed in rational time, at which to retrieve the parameter’s value.

Return Value

YES if the application successfully retrieved the parameter value; otherwise NO.

Discussion

When used to get the value of an angle parameter, the result will be expressed in counter-clockwise radians. Depending on the host application, the time value may be relative to the start of the timeline or to the start of the clip. See Timebase Type for more information.

See Also

Getting Parameter Values

- getIntValue:fromParm:atFxTime:

Retrieves the integer value of the specified parameter.

Required.

- getBoolValue:fromParm:atFxTime:

Retrieves the boolean value of the specified parameter.

Required.

- getRedValue:greenValue:blueValue:fromParm:atFxTime:

Retrieves the RGB color values of the specified parameter.

Required.

- getRedValue:greenValue:blueValue:alphaValue:fromParm:atFxTime:

Retrieves the RGBA color values of the specified parameter.

Required.

- getXValue:YValue:fromParm:atFxTime:

Retrieves the X,Y position value of the specified parameter.

Required.

- getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atFxTime:

Retrieves a bitmap image from the specified parameter.

Required.

- getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atFxTime:

Retrieves a texture image from the specified parameter.

Required.

- getPathID:fromParm:atFxTime:

Retrieves the path ID of a custom parameter at a given time.

Required.

- getCustomParameterValue:fromParm:

Retrieves the opaque value object of the specified custom parameter.

Required.

- getCustomParameterValue:fromParm:atFxTime:

Retrieves the opaque value object of the specified custom parameter at a given time.

Required.

- getFontName:fromParm:atFxTime:

Retrieves the family and typeface of the specified parameter at a given time.

Required.

- getParameterFlags:fromParm:

Retrieves the current state of the specified parameter.

Required.

- getStringParameterValue:fromParm:

Retrieves the string value of the specified parameter.

Required.