Skip to main content
Version: 21 Aug 2024

ml_media_webvtt.h

Classes

Name
structMLWebVTTData
WebVTT data structure.

Types

Name
typedef struct MLWebVTTDataMLWebVTTData
WebVTT data structure.

Enums

Name
enumMLWebVTTOrientation
{
MLWebVTTOrientation_Horizontal = 0,
MLWebVTTOrientation_Vertical = 1,
MLWebVTTOrientation_Ensure32Bits = 0x7FFFFFFF
}
Cue orientation setting.
enumMLWebVTTDirection
{
MLWebVTTDirection_Default = 0,
MLWebVTTDirection_LeftToRight = 1,
MLWebVTTDirection_RightToLeft = 2,
MLWebVTTDirection_Ensure32Bits = 0x7FFFFFFF
}
Cue direction setting.
enumMLWebVTTAlign
{
MLWebVTTAlign_Start = 0,
MLWebVTTAlign_Middle = 1,
MLWebVTTAlign_End = 2,
MLWebVTTAlign_Left = 3,
MLWebVTTAlign_Right = 4,
MLWebVTTAlign_Ensure32Bits = 0x7FFFFFFF
}
Cue aligment setting.

Enums Documentation

MLWebVTTOrientation

EnumeratorValueDescription
MLWebVTTOrientation_Horizontal0
MLWebVTTOrientation_Vertical1
MLWebVTTOrientation_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Cue orientation setting.

API Level:

  • 4

MLWebVTTDirection

EnumeratorValueDescription
MLWebVTTDirection_Default0
MLWebVTTDirection_LeftToRight1
MLWebVTTDirection_RightToLeft2
MLWebVTTDirection_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Cue direction setting.

API Level:

  • 4

MLWebVTTAlign

EnumeratorValueDescription
MLWebVTTAlign_Start0
MLWebVTTAlign_Middle1
MLWebVTTAlign_End2
MLWebVTTAlign_Left3
MLWebVTTAlign_Right4
MLWebVTTAlign_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Cue aligment setting.

Deprecated

Deprecated since 1.4.0. Scheduled for removal.

API Level:

  • 4

Types Documentation

MLWebVTTData

typedef struct MLWebVTTData MLWebVTTData;

WebVTT data structure.

More Info

Deprecated

Deprecated since 1.4.0. Scheduled for removal.

API Level:

  • 4

Source code

// %BANNER_BEGIN%
// ---------------------------------------------------------------------
// %COPYRIGHT_BEGIN%
// Copyright (c) 2017 Magic Leap, Inc. All Rights Reserved.
// Use of this file is governed by the Software License Agreement,
// located here: https://www.magicleap.com/software-license-agreement-ml2
// Terms and conditions applicable to third-party materials accompanying
// this distribution may also be found in the top-level NOTICE file
// appearing herein.
// %COPYRIGHT_END%
// ---------------------------------------------------------------------
// %BANNER_END%

#pragma once

#include "ml_api.h"
#include "ml_types.h"

ML_EXTERN_C_BEGIN

typedef enum MLWebVTTOrientation {
MLWebVTTOrientation_Horizontal = 0,
MLWebVTTOrientation_Vertical = 1,
MLWebVTTOrientation_Ensure32Bits = 0x7FFFFFFF
} MLWebVTTOrientation;

typedef enum MLWebVTTDirection {
MLWebVTTDirection_Default = 0,
MLWebVTTDirection_LeftToRight = 1,
MLWebVTTDirection_RightToLeft = 2,
MLWebVTTDirection_Ensure32Bits = 0x7FFFFFFF
} MLWebVTTDirection;

typedef enum MLWebVTTAlign {
MLWebVTTAlign_Start = 0,
MLWebVTTAlign_Middle = 1,
MLWebVTTAlign_End = 2,
MLWebVTTAlign_Left = 3,
MLWebVTTAlign_Right = 4,
MLWebVTTAlign_Ensure32Bits = 0x7FFFFFFF
} MLWebVTTAlign;

typedef ML_DEPRECATED_MSG("Use standard Android SDK APIs.") struct MLWebVTTData {
int64_t start_time_ms;
int64_t end_time_ms;
char *body;
char *id;
bool snap_to_lines;
MLWebVTTOrientation orientation;
MLWebVTTDirection direction;
float relative_line_position;
int32_t line_number;
float text_position;
float size;
MLWebVTTAlign align;
} MLWebVTTData;

ML_EXTERN_C_END