track

Documentation

Overview

Package track provides constructors and methods for the HTML <track> element.

The <track> HTML element is used as a child of the media elements, <audio> and <video>. It lets you specify timed text tracks (or time-based data), for example to automatically handle subtitles.

Index

• Variables
• func Captions(src string) *element
• func Chapters(src string) *element
• func Descriptions(src string) *element
• func Metadata(src string) *element
• func New() *element
• func Subtitles(src string) *element
• type Element

Variables

var (
	TagOpen = []byte("<track")

	AttrSrc     = []byte(" src=\"")
	AttrKind    = []byte(" kind=\"")
	AttrLabel   = []byte(" label=\"")
	AttrSrclang = []byte(" srclang=\"")
	AttrDefault = []byte(" default")
)

Byte constants for HTML rendering.

Functions

func Captions

func Captions(src string) *element

Captions creates a track element for captions (transcriptions including sound effects for deaf/hard-of-hearing users) Example: track.Captions("closed-captions.vtt") Renders: <track src="closed-captions.vtt" kind="captions" />

func Chapters

func Chapters(src string) *element

Chapters creates a track element for chapters (navigation cues) Example: track.Chapters("chapter-markers.vtt") Renders: <track src="chapter-markers.vtt" kind="chapters" />

func Descriptions

func Descriptions(src string) *element

Descriptions creates a track element for audio descriptions (for visually impaired users) Example: track.Descriptions("audio-descriptions.vtt") Renders: <track src="audio-descriptions.vtt" kind="descriptions" />

func Metadata

func Metadata(src string) *element

Metadata creates a track element for metadata (not displayed to users, used by scripts) Example: track.Metadata("analytics-data.vtt") Renders: <track src="analytics-data.vtt" kind="metadata" />

func New

func New() *element

New creates a new track element without any initial attributes. Example: track.New() Renders: <track />

func Subtitles

func Subtitles(src string) *element

Subtitles creates a track element for subtitles (translations for foreign language content) Example: track.Subtitles("english.vtt") Renders: <track src="english.vtt" kind="subtitles" />

Types

type Element

type Element = element

Element is an exported alias for the private element type