Creates a new instance with the specified raw value.
If there is no value of the type that corresponds with the specified raw
value, this initializer returns `nil`. For example:
enum PaperSize: String {
case A4, A5, Letter, Legal
}
print(PaperSize(rawValue: "Legal"))
// Prints "Optional(PaperSize.Legal)"
print(PaperSize(rawValue: "Tabloid"))
// Prints "nil"
- Parameter rawValue: The raw value to use for the new instance.
get · iOS 13.0+
rawValue
TypeScript
getRawValue($self: CMFormatDescription_Extensions_Value_TextDisplayFlags): number
Swift declaration
var rawValue: CMTextDisplayFlags
The corresponding value of the raw type.
A new instance initialized with `rawValue` will be equivalent to this
instance. For example:
enum PaperSize: String {
case A4, A5, Letter, Legal
}
let selectedSize = PaperSize.Letter
print(selectedSize.rawValue)
// Prints "Letter"
print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!)
// Prints "true"
The corresponding value of the raw type.
A new instance initialized with `rawValue` will be equivalent to this
instance. For example:
enum PaperSize: String {
case A4, A5, Letter, Legal
}
let selectedSize = PaperSize.Letter
print(selectedSize.rawValue)
// Prints "Letter"
print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!)
// Prints "true"
get · iOS 13.0+
fillTextRegion
TypeScript
get fillTextRegion(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let fillTextRegion: CMFormatDescription.Extensions.Value.TextDisplayFlags
The subtitle display bounds are to be filled with the color
specified by `.backgroundColor`.
get · iOS 13.0+
writeTextVertically
TypeScript
get writeTextVertically(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let writeTextVertically: CMFormatDescription.Extensions.Value.TextDisplayFlags
var scrollDirection: CMFormatDescription.Extensions.Value.TextDisplayFlags { get }
The scrollDirection part of this `TextDisplayFlags`
get · iOS 13.0+
continuousKaraoke
TypeScript
get continuousKaraoke(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let continuousKaraoke: CMFormatDescription.Extensions.Value.TextDisplayFlags
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.
get · iOS 13.0+
allSubtitlesForced
TypeScript
get allSubtitlesForced(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let allSubtitlesForced: CMFormatDescription.Extensions.Value.TextDisplayFlags
Treat all subtitle samples as if they contain forced subtitles.
get · iOS 13.0+
scrollDirectionMask
TypeScript
get scrollDirectionMask(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollDirectionMask: CMFormatDescription.Extensions.Value.TextDisplayFlags
The scrolling direction is set by a two-bit field, obtained from
displayFlags using `scrollDirectionMask`.
get · iOS 13.0+
forcedSubtitlesPresent
TypeScript
get forcedSubtitlesPresent(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let forcedSubtitlesPresent: CMFormatDescription.Extensions.Value.TextDisplayFlags
There are forced subtitles present, e.g., a subtitle which only
displays during foreign language sections of the video. Check
individual samples to determine what type of subtitle is contained.
get · iOS 13.0+
obeySubtitleFormatting
TypeScript
get obeySubtitleFormatting(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let obeySubtitleFormatting: CMFormatDescription.Extensions.Value.TextDisplayFlags
Specifies that the subtitle display bounds should be used to
determine if the subtitles should be placed near the top or the
bottom of the video. Otherwise, subtitles should be placed at the
bottom of the video.
get · iOS 13.0+
scrollDirection_bottomToTop
TypeScript
get scrollDirection_bottomToTop(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollDirection_bottomToTop: CMFormatDescription.Extensions.Value.TextDisplayFlags
Text is vertically scrolled up ("credits style"), entering from the
bottom and leaving towards the top.
get · iOS 13.0+
scrollDirection_leftToRight
TypeScript
get scrollDirection_leftToRight(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollDirection_leftToRight: CMFormatDescription.Extensions.Value.TextDisplayFlags
Text is horizontally scrolled, entering from the left and leaving
towards the right.
get · iOS 13.0+
scrollDirection_rightToLeft
TypeScript
get scrollDirection_rightToLeft(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollDirection_rightToLeft: CMFormatDescription.Extensions.Value.TextDisplayFlags
Text is horizontally scrolled ("marquee style"), entering from the
right and leaving towards the left.
get · iOS 13.0+
scrollDirection_topToBottom
TypeScript
get scrollDirection_topToBottom(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollDirection_topToBottom: CMFormatDescription.Extensions.Value.TextDisplayFlags
Text is vertically scrolled down, entering from the top and leaving
towards the bottom.
get · iOS 13.0+
scrollIn
TypeScript
get scrollIn(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollIn: CMFormatDescription.Extensions.Value.TextDisplayFlags
Text scrolls into the display region.
get · iOS 13.0+
scrollOut
TypeScript
get scrollOut(): CMFormatDescription_Extensions_Value_TextDisplayFlags
Swift declaration
static let scrollOut: CMFormatDescription.Extensions.Value.TextDisplayFlags
