Class Playback

Represents the operations that can be performed on a DataSource which has playback capabilities

Hierarchy

GemAutoreleaseObject
- Playback

Index

Accessors

currentPosition duration logPath maxSpeedMultiplier minSpeedMultiplier route speedMultiplier state

Methods

getLatestData pause registerAutoReleaseObject resume setCurrentPosition setLoopMode setSpeedMultiplier step init

Accessors

currentPosition

get currentPosition(): number
Return the current position (milliseconds from begin/departure/starting point).

Returns number
The playback position in milliseconds.
- Defined in core/sensedatasource.ts:693

duration

get duration(): number
The duration of the playback in milliseconds.

Returns number
The duration of the playback in milliseconds.
- Defined in core/sensedatasource.ts:721

logPath

get logPath(): string
Get the log path.

Returns string
The log path.
- Defined in core/sensedatasource.ts:771

maxSpeedMultiplier

get maxSpeedMultiplier(): number
Gets the maximum speed multiplier. Relevant for route based data source

Returns number
The maximum speed multiplier
- Defined in core/sensedatasource.ts:666

minSpeedMultiplier

get minSpeedMultiplier(): number
Gets the minimum speed multiplier. Relevant for route based data source

Returns number
The minimum speed multiplier
- Defined in core/sensedatasource.ts:680

route

get route(): Route | null
Get the route if it is a simulation data source.

Returns Route | null
The route on which the navigation in running or null if not available
- Defined in core/sensedatasource.ts:784

speedMultiplier

get speedMultiplier(): number
Get the speed multiplier. Relevant for route based data source

Returns number
The current speed multiplier
- Defined in core/sensedatasource.ts:635

state

get state(): PlayingStatus
Return the playback state of this data source.

Returns PlayingStatus
The status of the data source
- Defined in core/sensedatasource.ts:620

Methods

getLatestData

getLatestData(type: DataType): SenseData | null
The latest data from the DataSource.
Parameters
- type: DataType
  The type for which to get the sense data
Returns SenseData | null
The SenseData object if it exists, otherwise null.
- Defined in core/sensedatasource.ts:751

pause

pause(): GemError
Pause the playback.

Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:584

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

resume

resume(): GemError
Resume the playback.

Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:598

setCurrentPosition

setCurrentPosition(newPosition: number): number
Sets the current position (milliseconds from begin/departure/starting point).
Parameters
- newPosition: number
  The new position to be set
Returns number
The old playback position in milliseconds.
- Defined in core/sensedatasource.ts:707

setLoopMode

setLoopMode(loopMode: boolean): GemError
Sets play log continuously.
Parameters
- loopMode: boolean
  The actual value to be set for loop mode.
Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:735

setSpeedMultiplier

setSpeedMultiplier(speedMultiplier: number): GemError
Sets the speed multiplier. Relevant for route based data source
Parameters
- speedMultiplier: number
  the new speed multiplier
Returns GemError
GemError.success on success, other GemError values on failure
- Defined in core/sensedatasource.ts:650

step

step(): void
Step to the next frame. Only available for data sources that contain video.

Returns void
- Defined in core/sensedatasource.ts:612

`Static`init

init(id: number): Playback
Parameters
- id: number
Returns Playback
- Defined in core/sensedatasource.ts:573