<!--
{
  "documentType" : "article",
  "framework" : "CoreMedia",
  "identifier" : "/documentation/CoreMedia/text-display-flags",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Text Display Flags"
}
-->

# Text Display Flags

Flags that identify text display methods.

## Topics

### Constants

[`var kCMTextDisplayFlag_allSubtitlesForced: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_allSubtitlesForced)

A flag that describes treating all subtitle samples as if they contain forced subtitles.

[`var kCMTextDisplayFlag_continuousKaraoke: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_continuousKaraoke)

A flag that describes enabling the continuous karaoke mode where the range of karaoke highlighting extends to include additional ranges rather than the highlighting moves onto the next range.

[`var kCMTextDisplayFlag_fillTextRegion: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_fillTextRegion)

A flag that describes the subtitle display bounds are to be filled with the color specified by `kCMTextFormatDescriptionExtension_BackgroundColor`.

[`var kCMTextDisplayFlag_forcedSubtitlesPresent: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_forcedSubtitlesPresent)

A flag that describes forcing 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.

[`var kCMTextDisplayFlag_obeySubtitleFormatting: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_obeySubtitleFormatting)

A flag that describes using the subtitle display bounds to determine if the system places the subtitltes near the top or bottom of the video.

[`var kCMTextDisplayFlag_scrollDirectionMask: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollDirectionMask)

A flag that describes the scrolling direction is set by a two-bit field, obtained from displayFlags using kCMTextDisplayFlag_scrollDirectionMask.

[`var kCMTextDisplayFlag_scrollDirection_bottomToTop: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollDirection_bottomToTop)

A flag that describes the text is vertically scrolled up (“credits style”), entering from the bottom and leaving towards the top.

[`var kCMTextDisplayFlag_scrollDirection_leftToRight: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollDirection_leftToRight)

A flag that describes the text is horizontally scrolled, entering from the left and leaving towards the right.

[`var kCMTextDisplayFlag_scrollDirection_rightToLeft: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollDirection_rightToLeft)

A flag that describes the text is horizontally scrolled (“marquee style”), entering from the right and leaving towards the left.

[`var kCMTextDisplayFlag_scrollDirection_topToBottom: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollDirection_topToBottom)

A flag that describes the text is vertically scrolled down, entering from the top and leaving towards the bottom.

[`var kCMTextDisplayFlag_scrollIn: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollIn)

A flag that describes the text scrolls into the display region.

[`var kCMTextDisplayFlag_scrollOut: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_scrollOut)

A flag that describes the text scrolls out of the display region.

[`var kCMTextDisplayFlag_writeTextVertically: CMTextDisplayFlags`](/documentation/CoreMedia/kCMTextDisplayFlag_writeTextVertically)

A flag that describes the text renders vertically.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)