Class RTSPRange

Provides helper functions to deal with time ranges.

record

Hierarchy

RTSPRange

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RTSPRange(): RTSPRange

Returns RTSPRange

Properties

max

max: number

maximum value of the range

field

min

min: number

minimum value of the range

field

Static name

name: string

Methods

Static convertUnits

convertUnits(range: RTSPTimeRange, unit: RTSPRangeUnit): boolean

- Defined in GstRtsp-1.0.d.ts:1615
Converts the range in-place between different types of units. Ranges containing the special value #GST_RTSP_TIME_NOW can not be converted as these are only valid for #GST_RTSP_RANGE_NPT.

Parameters
- range: RTSPTimeRange
  
  a #GstRTSPTimeRange
- unit: RTSPRangeUnit
  
  the unit to convert the range into
Returns boolean

Static free

free(range: RTSPTimeRange): void

- Defined in GstRtsp-1.0.d.ts:1620
Free the memory allocated by range.

Parameters
- range: RTSPTimeRange
  
  a #GstRTSPTimeRange
Returns void

Static getTimes

getTimes(range: RTSPTimeRange): [boolean, number, number]

- Defined in GstRtsp-1.0.d.ts:1631
Retrieve the minimum and maximum values from range converted to #GstClockTime in min and max.

A value of %GST_CLOCK_TIME_NONE will be used to signal #GST_RTSP_TIME_NOW and #GST_RTSP_TIME_END for min and max respectively.

UTC times will be converted to nanoseconds since 1900.

Parameters
- range: RTSPTimeRange
  
  a #GstRTSPTimeRange
Returns [boolean, number, number]

Static parse

parse(rangestr: string): [RTSPResult, RTSPTimeRange]

- Defined in GstRtsp-1.0.d.ts:1636
Parse rangestr to a #GstRTSPTimeRange.

Parameters
- rangestr: string
  
  a range string to parse
Returns [RTSPResult, RTSPTimeRange]

Static toString

toString(range: RTSPTimeRange): string

- Defined in GstRtsp-1.0.d.ts:1641
Convert range into a string representation.

Parameters
- range: RTSPTimeRange
  
  a #GstRTSPTimeRange
Returns string