Interface: PlayerControlsProps

Props for the PlayerControls component. Defines the configuration options and callback functions for player controls.

Example

<PlayerControls
  selectedItem={selectedElement}
  currentTime={5.5}
  duration={120}
  canUndo={true}
  canRedo={false}
  playerState={PLAYER_STATE.PLAYING}
  togglePlayback={handleTogglePlayback}
  onUndo={handleUndo}
  onRedo={handleRedo}
  onDelete={handleDelete}
  onSplit={handleSplit}
  zoomLevel={1.0}
  setZoomLevel={handleZoomChange}
/>

Table of contents

Properties

• selectedItem
• selectedIds
• currentTime
• duration
• canUndo
• canRedo
• playerState
• togglePlayback
• onUndo
• onRedo
• onDelete
• onSplit
• zoomLevel
• setZoomLevel
• className
• zoomConfig
• fps
• onSeek
• followPlayheadEnabled
• onFollowPlayheadToggle

Properties

selectedItem

• selectedItem: null | Track | TrackElement

Currently selected timeline element or track (primary)

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:54

---

selectedIds

• Optional selectedIds: Set<string>

Set of selected IDs for multi-select

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:56

---

currentTime

• currentTime: number

Current playback time in seconds

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:58

---

duration

• duration: number

Total duration of the timeline in seconds

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:60

---

canUndo

• canUndo: boolean

Whether undo operation is available

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:62

---

canRedo

• canRedo: boolean

Whether redo operation is available

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:64

---

playerState

• playerState: string | number | symbol

Current player state (playing, paused, refresh)

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:66

---

togglePlayback

• togglePlayback: () => void

Function to toggle between play and pause

Type declaration

▸ (): void

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:68

---

onUndo

• Optional onUndo: () => void

Optional callback for undo operation

Type declaration

▸ (): void

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:70

---

onRedo

• Optional onRedo: () => void

Optional callback for redo operation

Type declaration

▸ (): void

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:72

---

onDelete

• Optional onDelete: () => void

Optional callback for delete operation (deletes all selected)

Type declaration

▸ (): void

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:74

---

onSplit

• Optional onSplit: (item: TrackElement, splitTime: number) => void

Optional callback for split operation

Type declaration

▸ (item, splitTime): void

Parameters

Name	Type
item	TrackElement
splitTime	number

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:76

---

zoomLevel

• Optional zoomLevel: number

Current zoom level for timeline

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:78

---

setZoomLevel

• Optional setZoomLevel: (zoom: number) => void

Function to set zoom level

Type declaration

▸ (zoom): void

Parameters

Name	Type
zoom	number

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:80

---

className

• Optional className: string

Optional CSS class name for styling

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:82

---

zoomConfig

• Optional zoomConfig: TimelineZoomConfig

Timeline zoom configuration (min, max, step, default)

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:84

---

fps

• Optional fps: number

Frames per second for time display (MM:SS.FF format)

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:86

---

onSeek

• Optional onSeek: (time: number) => void

Callback to seek to a specific time (for jump to start/end)

Type declaration

▸ (time): void

Parameters

Name	Type
time	number

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:88

---

followPlayheadEnabled

• Optional followPlayheadEnabled: boolean

Whether timeline follows playhead during playback

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:90

---

onFollowPlayheadToggle

• Optional onFollowPlayheadToggle: () => void

Toggle follow playhead

Type declaration

▸ (): void

Returns

void

Defined in

packages/video-editor/src/components/controls/player-controls.tsx:92