Returns the default text box.
SDKs
- iOS 4.0+
- macOS 10.7+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 6.0+
Framework
- Core Media
Declaration
OSStatus CMTextFormatDescriptionGetDefaultTextBox(CMFormatParameters
descFormatDescription being interrogated.
originIsAtTopLeftPass true if the
CGRectwill be used in an environment where (0,0) is at the top-left corner of an enclosing rectangle and y coordinates increase as you go down.Pass false if the
CGRectwill be used in an environment where (0,0) is at the bottom-left corner of an enclosing rectangle and y coordinates increase as you go up.heightOfTextTrackIf
originis false, pass the height of the enclosing text track or destination. This value will be used to properly compute the default text box for the given origin. Ignored ifIs At Top Left originis true.Is At Top Left outDefaultTextBoxOn output, receives the default text box.
Return Value
A result code. Returns no if successful.
Discussion
Within a text track, text is rendered within a text box. There is a default text box set, which can be over-ridden by a sample.