---
title: "TextTrackCue | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface TextTrackCue

The **`TextTrackCue`** interface of the WebVTT API is the abstract base class for the various derived cue types, such as VTTCue and DataCue; you will work with these derived types rather than the base class.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue)

interface TextTrackCue {  
    [endTime](#endtime): number;  
    [id](#id): string;  
    [onenter](#onenter): ((this: TextTrackCue, ev: Event) \=> any) | null;  
    [onexit](#onexit): ((this: TextTrackCue, ev: Event) \=> any) | null;  
    [pauseOnExit](#pauseonexit): boolean;  
    [startTime](#starttime): number;  
    [track](#track): [TextTrack](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrack/) | null;  
    [addEventListener](#addeventlistener-1)<[K](#addeventlistenerk) extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addEventListener](#addeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [dispatchEvent](#dispatchevent-1)(event: Event): boolean;  
    [removeEventListener](#removeeventlistener-1)<[K](#removeeventlistenerk) extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeEventListener](#removeeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void;  
}

#### Hierarchy

-   EventTarget
    -   TextTrackCue

##### Index

### Properties[](#properties)

[endTime](#endtime) [id](#id) [onenter](#onenter) [onexit](#onexit) [pauseOnExit](#pauseonexit) [startTime](#starttime) [track](#track)

### Methods[](#methods)

[addEventListener](#addeventlistener) [dispatchEvent](#dispatchevent) [removeEventListener](#removeeventlistener)

## Properties[](#properties-1)

### endTime[](#endtime)

endTime: number

The **`endTime`** property of the TextTrackCue interface returns and sets the end time of the cue.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/endTime)

### id[](#id)

id: string

The **`id`** property of the TextTrackCue interface returns and sets the identifier for this cue.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/id)

### onenter[](#onenter)

onenter: ((this: TextTrackCue, ev: Event) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/enter_event)

### onexit[](#onexit)

onexit: ((this: TextTrackCue, ev: Event) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/exit_event)

### pauseOnExit[](#pauseonexit)

pauseOnExit: boolean

The **`pauseOnExit`** property of the TextTrackCue interface returns or sets the flag indicating whether playback of the media should pause when the end of the range to which this cue applies is reached.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/pauseOnExit)

### startTime[](#starttime)

startTime: number

The **`startTime`** property of the TextTrackCue interface returns and sets the start time of the cue.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/startTime)

### `Readonly`track[](#track)

track: [TextTrack](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrack/) | null

The **`track`** read-only property of the TextTrackCue interface returns the TextTrack object that this cue belongs to.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/TextTrackCue/track)

## Methods[](#methods-1)

### addEventListener[](#addeventlistener)

-   addEventListener<[K](#addeventlistenerk) extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-1)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)
    
    #### Parameters
    
    -   type: [K](#addeventlistenerk)
    -   listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#addeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    
-   addEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-2)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    

### dispatchEvent[](#dispatchevent)

-   dispatchEvent(event: Event): boolean[](#dispatchevent-1)
    
    The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
    
    #### Parameters
    
    -   event: Event
    
    #### Returns boolean
    
    Inherited from EventTarget.dispatchEvent
    

### removeEventListener[](#removeeventlistener)

-   removeEventListener<[K](#removeeventlistenerk) extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-1)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)
    
    #### Parameters
    
    -   type: [K](#removeeventlistenerk)
    -   listener: (this: TextTrackCue, ev: [TextTrackCueEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.TextTrackCueEventMap/)\[[K](#removeeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    
-   removeEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-2)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener