Class VideoTimeCode

field_count must be 0 for progressive video and 1 or 2 for interlaced.

A representation of a SMPTE time code.

hours must be positive and less than 24. Will wrap around otherwise. minutes and seconds must be positive and less than 60. frames must be less than or equal to config.fps_n / config.fps_d These values are NOT automatically normalized.

record

Hierarchy

VideoTimeCode

Constructors

constructor

new VideoTimeCode(fps_n: number, fps_d: number, latest_daily_jam: GLib.DateTime, flags: VideoTimeCodeFlags, hours: number, minutes: number, seconds: number, frames: number, field_count: number): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9068
field_count is 0 for progressive, 1 or 2 for interlaced. latest_daiy_jam reference is stolen from caller.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- latest_daily_jam: GLib.DateTime
  
  The latest daily jam of the #GstVideoTimeCode
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- hours: number
  
  the hours field of #GstVideoTimeCode
- minutes: number
  
  the minutes field of #GstVideoTimeCode
- seconds: number
  
  the seconds field of #GstVideoTimeCode
- frames: number
  
  the frames field of #GstVideoTimeCode
- field_count: number
  
  Interlaced video field count
Returns VideoTimeCode

Properties

config

config: VideoTimeCodeConfig

the corresponding #GstVideoTimeCodeConfig

field

field_count

field_count: number

Interlaced video field count

field

frames

frames: number

the frames field of #GstVideoTimeCode

field

hours

hours: number

the hours field of #GstVideoTimeCode

field

minutes

minutes: number

the minutes field of #GstVideoTimeCode

field

seconds

seconds: number

the seconds field of #GstVideoTimeCode

field

Static name

name: string

Methods

add_frames

add_frames(frames: number): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8951
Adds or subtracts frames amount of frames to tc. tc needs to contain valid data, as verified by gst_video_time_code_is_valid().

Parameters
- frames: number
  
  How many frames to add or subtract
Returns void

add_interval

add_interval(tc_inter: VideoTimeCodeInterval): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8962
This makes a component-wise addition of tc_inter to tc. For example, adding ("01:02:03:04", "00:01:00:00") will return "01:03:03:04". When it comes to drop-frame timecodes, adding ("00:00:00;00", "00:01:00:00") will return "00:01:00;02" because of drop-frame oddities. However, adding ("00:09:00;02", "00:01:00:00") will return "00:10:00;00" because this time we can have an exact minute.

Parameters
- tc_inter: VideoTimeCodeInterval
  
  The #GstVideoTimeCodeInterval to add to tc. The interval must contain valid values, except that for drop-frame timecode, it may also contain timecodes which would normally be dropped. These are then corrected to the next reasonable timecode.
Returns VideoTimeCode

clear

clear(): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8967
Initializes tc with empty/zero/NULL values and frees any memory it might currently use.

Returns void

compare

compare(tc2: VideoTimeCode): number

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8974
Compares tc1 and tc2. If both have latest daily jam information, it is taken into account. Otherwise, it is assumed that the daily jam of both tc1 and tc2 was at the same time. Both time codes must be valid.

Parameters
- tc2: VideoTimeCode
  
  another valid #GstVideoTimeCode
Returns number

copy

copy(): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8975
Returns VideoTimeCode

frames_since_daily_jam

frames_since_daily_jam(): number

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8976
Returns number

free

free(): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8980
Frees tc.

Returns void

increment_frame

increment_frame(): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:8984
Adds one frame to tc.

Returns void

init

init(fps_n: number, fps_d: number, latest_daily_jam: GLib.DateTime, flags: VideoTimeCodeFlags, hours: number, minutes: number, seconds: number, frames: number, field_count: number): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9002
field_count is 0 for progressive, 1 or 2 for interlaced. latest_daiy_jam reference is stolen from caller.

Initializes tc with the given values. The values are not checked for being in a valid range. To see if your timecode actually has valid content, use gst_video_time_code_is_valid().

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- latest_daily_jam: GLib.DateTime
  
  The latest daily jam of the #GstVideoTimeCode
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- hours: number
  
  the hours field of #GstVideoTimeCode
- minutes: number
  
  the minutes field of #GstVideoTimeCode
- seconds: number
  
  the seconds field of #GstVideoTimeCode
- frames: number
  
  the frames field of #GstVideoTimeCode
- field_count: number
  
  Interlaced video field count
Returns void

init_from_date_time

init_from_date_time(fps_n: number, fps_d: number, dt: GLib.DateTime, flags: VideoTimeCodeFlags, field_count: number): void

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9015
The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time.

Will assert on invalid parameters, use gst_video_time_code_init_from_date_time_full() for being able to handle invalid parameters.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- dt: GLib.DateTime
  
  #GDateTime to convert
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- field_count: number
  
  Interlaced video field count
Returns void

init_from_date_time_full

init_from_date_time_full(fps_n: number, fps_d: number, dt: GLib.DateTime, flags: VideoTimeCodeFlags, field_count: number): boolean

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9025
The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- dt: GLib.DateTime
  
  #GDateTime to convert
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- field_count: number
  
  Interlaced video field count
Returns boolean

is_valid

is_valid(): boolean

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9026
Returns boolean

nsec_since_daily_jam

nsec_since_daily_jam(): number

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9027
Returns number

to_date_time

to_date_time(): GLib.DateTime

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9031
The tc.config->latest_daily_jam is required to be non-NULL.

Returns GLib.DateTime

to_string

to_string(): string

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9032
Returns string

Static new

new(fps_n: number, fps_d: number, latest_daily_jam: GLib.DateTime, flags: VideoTimeCodeFlags, hours: number, minutes: number, seconds: number, frames: number, field_count: number): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9083
field_count is 0 for progressive, 1 or 2 for interlaced. latest_daiy_jam reference is stolen from caller.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- latest_daily_jam: GLib.DateTime
  
  The latest daily jam of the #GstVideoTimeCode
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- hours: number
  
  the hours field of #GstVideoTimeCode
- minutes: number
  
  the minutes field of #GstVideoTimeCode
- seconds: number
  
  the seconds field of #GstVideoTimeCode
- frames: number
  
  the frames field of #GstVideoTimeCode
- field_count: number
  
  Interlaced video field count
Returns VideoTimeCode

Static new_empty

new_empty(): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9084
Returns VideoTimeCode

Static new_from_date_time

new_from_date_time(fps_n: number, fps_d: number, dt: GLib.DateTime, flags: VideoTimeCodeFlags, field_count: number): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9099
The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time.

This might return a completely invalid timecode, use gst_video_time_code_new_from_date_time_full() to ensure that you would get %NULL instead in that case.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- dt: GLib.DateTime
  
  #GDateTime to convert
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- field_count: number
  
  Interlaced video field count
Returns VideoTimeCode

Static new_from_date_time_full

new_from_date_time_full(fps_n: number, fps_d: number, dt: GLib.DateTime, flags: VideoTimeCodeFlags, field_count: number): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9110
The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time.

Parameters
- fps_n: number
  
  Numerator of the frame rate
- fps_d: number
  
  Denominator of the frame rate
- dt: GLib.DateTime
  
  #GDateTime to convert
- flags: VideoTimeCodeFlags
  
  #GstVideoTimeCodeFlags
- field_count: number
  
  Interlaced video field count
Returns VideoTimeCode

Static new_from_string

new_from_string(tc_str: string): VideoTimeCode

- Defined in @types/Gjs/GstVideo-1.0.d.ts:9111
Parameters
- tc_str: string
Returns VideoTimeCode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fps_n: number

fps_d: number

latest_daily_jam: GLib.DateTime

flags: VideoTimeCodeFlags

hours: number

minutes: number

seconds: number

frames: number

field_count: number

Returns VideoTimeCode

Properties

config

field_count

frames

hours

minutes

seconds

Static name

Methods

add_frames

Parameters

frames: number

Returns void

add_interval

Parameters

tc_inter: VideoTimeCodeInterval

Returns VideoTimeCode

clear

Returns void

compare

Parameters

tc2: VideoTimeCode

Returns number

copy

Returns VideoTimeCode

frames_since_daily_jam

Returns number

free

Returns void

increment_frame

Returns void

init

Parameters

fps_n: number

fps_d: number

latest_daily_jam: GLib.DateTime

flags: VideoTimeCodeFlags

hours: number

minutes: number

seconds: number

frames: number

field_count: number

Returns void

init_from_date_time

Parameters

fps_n: number

fps_d: number

dt: GLib.DateTime

flags: VideoTimeCodeFlags

field_count: number

Returns void

init_from_date_time_full

Parameters

fps_n: number

fps_d: number

dt: GLib.DateTime

flags: VideoTimeCodeFlags

field_count: number

Returns boolean

is_valid

Returns boolean

nsec_since_daily_jam