BMPVttProperties

Objective-C

@interface BMPVttProperties : NSObject
/**
 Returns the writing direction

 @note: BMPVttVerticalUnset means the writing direction should be horizontal

 Default: BMPVttVerticalUnset
 */
@property (nonatomic, readonly) BMPVttVertical vertical;
/**
 Returns the vertical position of the cue box
 */
@property (nonatomic, readonly) BMPVttLine *line;
/**
 Returns the alignment of the line property.

 @discussion: See BMPVttLineAlign for more information
 */
@property (nonatomic, readonly) BMPVttLineAlign lineAlign;
/**
 Returns whether the line attribute should be interpreted as absolute line number or as relative position
 */
@property (nonatomic, readonly) BOOL snapToLines;
/**
 Returns the size of the cue box relative to the video dimensions

 Default: 100

 @note: If the writing direction is horizontal, then the size percentages are relative to the width of the video, otherwise to the height of the video
 */
@property (nonatomic, readonly) double size;
/**
 Returns the text alignment inside the cue box
 */
@property (nonatomic, readonly) BMPVttAlign align;
/**
 Returns the horizontal position of the cue box
 */
@property (nonatomic, readonly) BMPVttPosition *position;
/**
 Returns the alignment of the line property.

 Default: BMPVttPositionAlignAuto

 @discussion: See BMPVttPositionAlign for more information
 */
@property (nonatomic, readonly) BMPVttPositionAlign positionAlign;
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
@end

Swift

class VttProperties : NSObject

Undocumented

  • Returns the writing direction

    @note: BMPVttVerticalUnset means the writing direction should be horizontal

    Default: BMPVttVerticalUnset

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttVertical _Nonnull vertical;

    Swift

    var vertical: VttVertical { get }

  • Returns the vertical position of the cue box

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttLine *_Nonnull line;

    Swift

    var line: BMPVttLine { get }

  • Returns the alignment of the line property.

    @discussion: See BMPVttLineAlign for more information

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttLineAlign _Nonnull lineAlign;

    Swift

    var lineAlign: VttLineAlign { get }

  • Returns whether the line attribute should be interpreted as absolute line number or as relative position

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL snapToLines;

    Swift

    var snapToLines: Bool { get }

  • Returns the size of the cue box relative to the video dimensions

    Default: 100

    @note: If the writing direction is horizontal, then the size percentages are relative to the width of the video, otherwise to the height of the video

    Declaration

    Objective-C

    @property (nonatomic, readonly) double size;

    Swift

    var size: Double { get }

  • Returns the text alignment inside the cue box

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttAlign _Nonnull align;

    Swift

    var align: VttAlign { get }

  • Returns the horizontal position of the cue box

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttPosition *_Nonnull position;

    Swift

    var position: BMPVttPosition { get }

  • Returns the alignment of the line property.

    Default: BMPVttPositionAlignAuto

    @discussion: See BMPVttPositionAlign for more information

    Declaration

    Objective-C

    @property (nonatomic, readonly) BMPVttPositionAlign _Nonnull positionAlign;

    Swift

    var positionAlign: VttPositionAlign { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (instancetype)new NS_UNAVAILABLE;