youtube_explode/lib/src/videos/closed_captions/closed_caption_track_info.dart

56 lines
1.5 KiB
Dart
Raw Normal View History

2020-02-24 14:28:52 +01:00
import 'package:equatable/equatable.dart';
2020-06-03 23:02:21 +02:00
import 'language.dart';
2020-02-23 20:29:08 +01:00
/// Metadata associated with a certain [ClosedCaptionTrack]
2020-02-24 14:28:52 +01:00
class ClosedCaptionTrackInfo extends Equatable {
2020-02-23 20:29:08 +01:00
/// Manifest URL of the associated track.
final Uri url;
2020-02-23 21:00:35 +01:00
/// Language of the associated track.
2020-02-23 20:29:08 +01:00
final Language language;
2020-02-23 21:00:35 +01:00
/// Whether the associated track was automatically generated.
2020-02-23 20:29:08 +01:00
final bool isAutoGenerated;
2020-11-01 15:05:19 +01:00
/// Track format
final ClosedCaptionFormat format;
2020-02-23 21:00:35 +01:00
/// Initializes an instance of [ClosedCaptionTrackInfo]
2020-11-01 15:05:19 +01:00
const ClosedCaptionTrackInfo(this.url, this.language,
{this.isAutoGenerated = false, this.format})
: assert(format != null);
2020-02-24 14:28:52 +01:00
2020-06-03 23:02:21 +02:00
@override
String toString() => 'CC Track ($language)';
2020-02-24 14:28:52 +01:00
@override
List<Object> get props => [url, language, isAutoGenerated];
2020-02-23 21:00:35 +01:00
}
2020-11-01 15:05:19 +01:00
/// SubTiles format.
class ClosedCaptionFormat {
/// .srv format(1).
static const ClosedCaptionFormat srv1 = ClosedCaptionFormat._('srv1');
/// .srv format(2).
static const ClosedCaptionFormat srv2 = ClosedCaptionFormat._('srv2');
/// .srv format(3).
static const ClosedCaptionFormat srv3 = ClosedCaptionFormat._('srv3');
/// .ttml format.
static const ClosedCaptionFormat ttml = ClosedCaptionFormat._('ttml');
/// .vtt format.
static const ClosedCaptionFormat vtt = ClosedCaptionFormat._('vtt');
/// List of all sub titles format.
static const List<ClosedCaptionFormat> values = [srv1, srv2, srv3, ttml, vtt];
/// Format code as string.
final String formatCode;
const ClosedCaptionFormat._(this.formatCode);
}