Contents

VTSessionCopyProperty(_:key:allocator:valueOut:)

Retrieves a property on a Video Toolbox session.

Declaration

func VTSessionCopyProperty(_ session: VTSession, key propertyKey: CFString, allocator: CFAllocator?, valueOut propertyValueOut: UnsafeMutableRawPointer?) -> OSStatus

Parameters

  • session:

    A Video Toolbox session object.

  • propertyKey:

    The key for the property to retrieve.

  • allocator:

    An allocator suitable for use when copying property values.

  • propertyValueOut:

    Points to a variable to receive the property value, which must be a CF-registered type – the caller may call Cfgettypeid(_:) on it to identify which specific type. The caller must release the this property value.

Return Value

noErr if successful; kVTPropertyNotSupportedErr for unrecognized or unsupported properties.

Discussion

See Also

Getting Properties