Gst-1.0 ▶ Gst ▶ DateTime

constructor

• new DateTime(properties?: Partial<{}>): Gst.DateTime

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Gst.DateTime

Static$gtype

get_day

• get_day(): number

  Returns the day of the month of this Gst.DateTime.

  Returns number

  The day of this Gst.DateTime, or -1 if none is set.

get_hour

• get_hour(): number

  Retrieves the hour of the day represented by datetime in the gregorian calendar. The return is in the range of 0 to 23.

  Returns number

  the hour of the day, or -1 if none is set.

get_microsecond

• get_microsecond(): number

  Retrieves the fractional part of the seconds in microseconds represented by datetime in the gregorian calendar.

  Returns number

  the microsecond of the second, or -1 if none is set.

get_minute

• get_minute(): number

  Retrieves the minute of the hour represented by datetime in the gregorian calendar.

  Returns number

  the minute of the hour, or -1 if none is set.

get_month

• get_month(): number

  Returns the month of this Gst.DateTime. January is 1, February is 2, etc..

  Returns number

  The month of this Gst.DateTime, or -1 if none is set.

get_second

• get_second(): number

  Retrieves the second of the minute represented by datetime in the gregorian calendar.

  Returns number

  the second represented by datetime, or -1 if none is set.

get_time_zone_offset

• get_time_zone_offset(): number

  Retrieves the offset from UTC in hours that the timezone specified by datetime represents. Timezones ahead (to the east) of UTC have positive values, timezones before (to the west) of UTC have negative values. If datetime represents UTC time, then the offset is zero.

  Returns number

  the offset from UTC in hours, or G_MAXFLOAT if none is set.

get_year

• get_year(): number

  Returns the year of this Gst.DateTime. Call gst_date_time_has_year() before, to avoid warnings.

  Returns number

  The year of this Gst.DateTime

has_day

• has_day(): boolean

  Returns boolean

  true if datetime's day field is set, otherwise false

has_month

• has_month(): boolean

  Returns boolean

  true if datetime's month field is set, otherwise false

has_second

• has_second(): boolean

  Returns boolean

  true if datetime's second field is set, otherwise false

has_time

• has_time(): boolean

  Returns boolean

  true if datetime's hour and minute fields are set, otherwise false

has_year

• has_year(): boolean

  Returns boolean

  true if datetime's year field is set (which should always be the case), otherwise false

ref

• ref(): Gst.DateTime

  Atomically increments the reference count of datetime by one.

  Returns Gst.DateTime

  the reference datetime

to_g_date_time

• to_g_date_time(): GLib.DateTime

  Creates a new GLib.DateTime from a fully defined Gst.DateTime object.

  Returns GLib.DateTime

  a newly created GLib.DateTime, or null on error or if datetime does not have a year, month, day, hour, minute and second.

to_iso8601_string

• to_iso8601_string(): string

  Create a minimal string compatible with ISO-8601. Possible output formats are (for example): 2012, 2012-06, 2012-06-23, 2012-06-23T23:30Z, 2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100

  Returns string

  a newly allocated string formatted according to ISO 8601 and only including the datetime fields that are valid, or null in case there was an error.

unref

• unref(): void

  Atomically decrements the reference count of datetime by one. When the reference count reaches zero, the structure is freed.

  Returns void

Staticnew

• new(
      tzoffset: number,
      year: number,
      month: number,
      day: number,
      hour: number,
      minute: number,
      seconds: number,
  ): Gst.DateTime

  Parameters

  • tzoffset: number
  • year: number
  • month: number
  • day: number
  • hour: number
  • minute: number
  • seconds: number

  Returns Gst.DateTime

Staticnew_from_g_date_time

• new_from_g_date_time(dt?: GLib.DateTime): Gst.DateTime

  Parameters

  • Optionaldt: GLib.DateTime

  Returns Gst.DateTime

Staticnew_from_iso8601_string

• new_from_iso8601_string(string: string): Gst.DateTime

  Parameters

  • string: string

  Returns Gst.DateTime

Staticnew_from_unix_epoch_local_time

• new_from_unix_epoch_local_time(secs: number): Gst.DateTime

  Parameters

  • secs: number

  Returns Gst.DateTime

Staticnew_from_unix_epoch_local_time_usecs

• new_from_unix_epoch_local_time_usecs(usecs: number): Gst.DateTime

  Parameters

  • usecs: number

  Returns Gst.DateTime

Staticnew_from_unix_epoch_utc

• new_from_unix_epoch_utc(secs: number): Gst.DateTime

  Parameters

  • secs: number

  Returns Gst.DateTime

Staticnew_from_unix_epoch_utc_usecs

• new_from_unix_epoch_utc_usecs(usecs: number): Gst.DateTime

  Parameters

  • usecs: number

  Returns Gst.DateTime

Staticnew_local_time

• new_local_time(
      year: number,
      month: number,
      day: number,
      hour: number,
      minute: number,
      seconds: number,
  ): Gst.DateTime

  Parameters

  • year: number
  • month: number
  • day: number
  • hour: number
  • minute: number
  • seconds: number

  Returns Gst.DateTime

Staticnew_now_local_time

• new_now_local_time(): Gst.DateTime

  Returns Gst.DateTime

Staticnew_now_utc

• new_now_utc(): Gst.DateTime

  Returns Gst.DateTime

Staticnew_y

• new_y(year: number): Gst.DateTime

  Parameters

  • year: number

  Returns Gst.DateTime

Staticnew_ym

• new_ym(year: number, month: number): Gst.DateTime

  Parameters

  • year: number
  • month: number

  Returns Gst.DateTime

Staticnew_ymd

• new_ymd(year: number, month: number, day: number): Gst.DateTime

  Parameters

  • year: number
  • month: number
  • day: number

  Returns Gst.DateTime