Enumeration

Text Display Flags

No overview available.

Declaration

enum : CMTextDisplayFlags {
    ...
};

Topics

Constants

kCMTextDisplayFlag_allSubtitlesForced

Treat all subtitle samples as if they contain forced subtitles.

kCMTextDisplayFlag_continuousKaraoke

Enables the Continuous Karaoke mode where the range of karaoke highlighting extends to include additional ranges rather than the highlighting moves onto the next range.

kCMTextDisplayFlag_fillTextRegion

The subtitle display bounds are to be filled with the color specified by kCMTextFormatDescriptionExtension_BackgroundColor.

kCMTextDisplayFlag_forcedSubtitlesPresent

Forced subtitles are present, for example, a subtitle which only displays during foreign language sections of the video. Check individual samples to determine what type of subtitle is contained.

kCMTextDisplayFlag_scrollDirectionMask

The scrolling direction is set by a two-bit field, obtained from displayFlags using kCMTextDisplayFlag_scrollDirectionMask.

kCMTextDisplayFlag_scrollDirection_bottomToTop

Text is vertically scrolled up (“credits style”), entering from the bottom and leaving towards the top.

kCMTextDisplayFlag_scrollDirection_leftToRight

Text is horizontally scrolled, entering from the left and leaving towards the right.

kCMTextDisplayFlag_scrollDirection_rightToLeft

Text is horizontally scrolled (“marquee style”), entering from the right and leaving towards the left.

kCMTextDisplayFlag_scrollDirection_topToBottom

Text is vertically scrolled down, entering from the top and leaving towards the bottom.

kCMTextDisplayFlag_scrollIn

Text scrolls into the display region.

kCMTextDisplayFlag_scrollOut

Text scrolls out of the display region.

kCMTextDisplayFlag_writeTextVertically

Specifies the text to be rendered vertically.