#Interface: ITimelinePlayer experimental

player

Beta

A pane that hosts a single playhead and a collection of timeline entries that share it

#Extends

• IPropertyItemBase.IPane

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#entryCount

readonly entryCount: number

Beta

#Remarks

Number of timeline entries owned by this player.

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addGroup()

addGroup(id, name, tooltip?): void

Beta

#Parameters

#id

string

Unique identifier for the group.

#name

LocalizedString

Localized display name for the group.

#tooltip?

LocalizedString

Optional localized tooltip shown when hovering over the dropdown entry.

#Returns

void

#Remarks

Add a group to the dropdown.

---

#addVector3Timeline()

addVector3Timeline(options): IVector3TimelinePlayerEntry

Beta

#Parameters

#options

IVector3TimelinePlayerEntryOptions

Per-entry options.

#Returns

IVector3TimelinePlayerEntry

#Remarks

Add a Vector3 timeline entry to the player.

---

#getDuration()

getDuration(): number

Beta

#Returns

number

#Remarks

Get the total duration in seconds.

---

#getEntryById()

getEntryById(id): ITimelinePlayerEntry | undefined

Beta

#Parameters

#id

string

Entry identifier.

#Returns

ITimelinePlayerEntry | undefined

#Remarks

Look up an entry by id.

---

#getEntryByIndex()

getEntryByIndex(index): ITimelinePlayerEntry | undefined

Beta

#Parameters

#index

number

Entry index.

#Returns

ITimelinePlayerEntry | undefined

#Remarks

Look up an entry by index.

---

#getGroups()

getGroups(): ITimelinePlayerGroup[]

Beta

#Returns

ITimelinePlayerGroup[]

#Remarks

Get the current list of groups.

---

#getPlaybackState()

getPlaybackState(): TimelinePlayerPlaybackState

Beta

#Returns

TimelinePlayerPlaybackState

#Remarks

Get the current playback state.

---

#getPrecision()

getPrecision(): number

Beta

#Returns

number

#Remarks

Get the decimal precision used for keyframe time spacing.

---

#getSelectedGroupId()

getSelectedGroupId(): string

Beta

#Returns

string

#Remarks

Get the currently selected group identifier.

---

#getTime()

getTime(): number

Beta

#Returns

number

#Remarks

Get the playhead time in seconds.

---

#hide()

hide(): void

Beta

#Returns

void

#Remarks

Hide the pane.

#Inherited from

IPane.hide

---

#removeEntry()

removeEntry(id): boolean

Beta

#Parameters

#id

string

Entry identifier.

#Returns

boolean

#Remarks

Remove an entry by id.

---

#removeGroup()

removeGroup(id): void

Beta

#Parameters

#id

string

Identifier of the group to remove.

#Returns

void

#Remarks

Remove a group from the dropdown.

---

#renameGroup()

renameGroup(id, newName): void

Beta

#Parameters

#id

string

Identifier of the group to rename.

#newName

LocalizedString

New localized display name.

#Returns

void

#Remarks

Rename a group in the dropdown.

---

#setDuration()

setDuration(duration): void

Beta

#Parameters

#duration

number

New duration in seconds.

#Returns

void

#Remarks

Set the total duration in seconds.

---

#setPlaybackState()

setPlaybackState(state): void

Beta

#Parameters

#state

TimelinePlayerPlaybackState

New playback state.

#Returns

void

#Remarks

Set the playback state.

---

#setPrecision()

setPrecision(precision): void

Beta

#Parameters

#precision

number

Decimal precision.

#Returns

void

#Remarks

Set the decimal precision used for keyframe time spacing.

---

#setSelectedGroupId()

setSelectedGroupId(id): void

Beta

#Parameters

#id

string

Identifier of the group to select.

#Returns

void

#Remarks

Set the selected group.

---

#setTime()

setTime(time): void

Beta

#Parameters

#time

number

New playhead time in seconds.

#Returns

void

#Remarks

Set the playhead time.

---

#show()

show(): void

Beta

#Returns

void

#Remarks

Show the pane and all of its items.

#Inherited from

IPane.show

#同领域相关

• ITimelinePlayerEntry
• ITimelinePlayerGroup
• ITimelinePlayerOptions
• IVector3TimelinePlayerEntry
• IVector3TimelinePlayerEntryOptions
• TimelinePlayerPlaybackState