upipe-av/upipe_avformat_sink.h header reference

Upipe sink module libavformat wrapper More

Header inclusion [link] 

Members [link] 

Types [link] 

Functions [link] 

Description [link] 

Upipe sink module libavformat wrapper

Members detail [link] 

#define UPIPE_AVFSINK_INPUT_SIGNATURE [link] 

This macro is declared in upipe-av/upipe_avformat_sink.h source file, line 40.

#define UPIPE_AVFSINK_SIGNATURE [link] 

This macro is declared in upipe-av/upipe_avformat_sink.h source file, line 39.

#define _UPIPE_AV_UPIPE_AVFORMAT_SINK_H_ [link] 

This macro is declared in upipe-av/upipe_avformat_sink.h source file, line 31.

enum upipe_avfsink_command [link] 

This enum is declared in upipe-av/upipe_avformat_sink.h source file, line 55.

This enum extends upipe_command with specific commands for avformat sink.

IdentifierValueDescription
UPIPE_AVFSINK_SENTINEL0x8000
UPIPE_AVFSINK_GET_MIME1returns the currently configured MIME type (const char **)
UPIPE_AVFSINK_SET_MIME2sets the MIME type (const char *)
UPIPE_AVFSINK_GET_FORMAT3returns the currently configured format name (const char **)
UPIPE_AVFSINK_SET_FORMAT4sets the format name (const char *)
UPIPE_AVFSINK_GET_DURATION5returns the current duration (uint64_t *)
UPIPE_AVFSINK_GET_INIT_URI6returns the currently configured init section uri (const char **)
UPIPE_AVFSINK_SET_INIT_URI7sets the init section uri (const char *)
UPIPE_AVFSINK_GET_TS_OFFSET8returns timestamp offset (uint64_t *)
UPIPE_AVFSINK_SET_TS_OFFSET9sets the timestamp offset (uint64_t)
UPIPE_AVFSINK_GET_POSITION10returns the current position of the sink, in octets (uint64_t *)
UPIPE_AVFSINK_SET_METADATA11sets a metadata value (const char *, const char *)

int upipe_avfsink_get_duration(struct upipe *upipe, uint64_t *duration_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 167.

This function returns the current duration.

Parameter list:

  • upipe: description structure of the pipe
  • duration_p: filled in with the current duration

The return value is an error code

int upipe_avfsink_get_format(struct upipe *upipe, const char **format_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 140.

This function returns the currently configured format.

Parameter list:

  • upipe: description structure of the pipe
  • format_p: filled in with the currently configured format name

The return value is an error code

int upipe_avfsink_get_init_uri(struct upipe *upipe, const char **uri_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 180.

This function returns the currently configured init section uri

Parameter list:

  • upipe: description structure of the pipe
  • uri_p: filled in with the current initialization section URI

The return value is an error code

int upipe_avfsink_get_mime(struct upipe *upipe, const char **mime_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 114.

This function returns the currently configured MIME type.

Parameter list:

  • upipe: description structure of the pipe
  • mime_p: filled in with the currently configured MIME type

The return value is an error code

int upipe_avfsink_get_position(struct upipe *upipe, uint64_t *position_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 232.

This function gets the current file position

Parameter list:

  • upipe: description structure of the pipe
  • position_p: filled with current position, in octets

The return value is an error code

int upipe_avfsink_get_ts_offset(struct upipe *upipe, uint64_t *ts_offset_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 206.

This function returns the current ts_offset

Parameter list:

  • upipe: description structure of the pipe
  • ts_offset_p: filled with the timestamp offset

The return value is an error code

enum upipe_avfsink_input_command [link] 

This enum is declared in upipe-av/upipe_avformat_sink.h source file, line 83.

This enum enumerates the avformat sink sub pipe private commands.

IdentifierValueDescription
UPIPE_AVFSINK_INPUT_SENTINEL0x8000
UPIPE_AVFSINK_INPUT_SET_DEFAULT1set the default disposition (int)
UPIPE_AVFSINK_INPUT_GET_DEFAULT2get the default disposition (int *)
UPIPE_AVFSINK_INPUT_SET_TIME_BASE3set the container time base, in ticks per second (uint64_t)
UPIPE_AVFSINK_INPUT_GET_TIME_BASE4get the container time base, in ticks per second (uint64_t *)
UPIPE_AVFSINK_INPUT_SET_TS_MAX5set the timestamps upper limit (uint64_t)
UPIPE_AVFSINK_INPUT_GET_TS_MAX6get the timestamps upper limit (uint64_t *)

int upipe_avfsink_input_get_default(struct upipe *upipe, int *value_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 273.

This function gets the default disposition flag.

Parameter list:

  • upipe: description structure of the subpipe
  • value_p: filled with the flag value

The return value is an error code

int upipe_avfsink_input_get_time_base(struct upipe *upipe, uint64_t *time_base_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 299.

This function gets the current container time base

Parameter list:

  • upipe: description structure of the pipe
  • time_base_p: filled with the time base in ticks per second

The return value is an error code

int upipe_avfsink_input_get_ts_max(struct upipe *upipe, uint64_t *ts_max_p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 325.

This function gets the timestamps upper limit

Parameter list:

  • upipe: description structure of the pipe
  • ts_max_p: filled with the upper limit, in container time base

The return value is an error code

int upipe_avfsink_input_set_default(struct upipe *upipe, int value) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 260.

This function sets the default disposition flag.

Parameter list:

  • upipe: description structure of the subpipe
  • value: value of the flag to set

The return value is an error code

int upipe_avfsink_input_set_time_base(struct upipe *upipe, uint64_t time_base) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 286.

This function sets the container time base

Parameter list:

  • upipe: description structure of the pipe
  • time_base: time base in ticks per second

The return value is an error code

int upipe_avfsink_input_set_ts_max(struct upipe *upipe, uint64_t ts_max) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 312.

This function sets the timestamps upper limit

Parameter list:

  • upipe: description structure of the pipe
  • ts_max: upper limit, in container time base

The return value is an error code

struct upipe_mgr * upipe_avfsink_mgr_alloc(void ) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 104.

This function returns the management structure for all avformat sinks.

The return value is pointer to manager

int upipe_avfsink_set_format(struct upipe *upipe, const char *format) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 154.

This function sets the format. It only takes effect after the next call to upipe_set_uri.

Parameter list:

  • upipe: description structure of the pipe
  • format: format name

The return value is an error code

int upipe_avfsink_set_init_uri(struct upipe *upipe, const char *uri) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 193.

This function sets the init section uri

Parameter list:

  • upipe: description structure of the pipe
  • uri: initialization section URI

The return value is an error code

int upipe_avfsink_set_metadata(struct upipe *upipe, const char *key, const char *value) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 247.

This function sets a metadata value

Parameter list:

  • upipe: description structure of the pipe
  • key: metadata key
  • value: metadata value

The return value is an error code

int upipe_avfsink_set_mime(struct upipe *upipe, const char *mime) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 127.

This function sets the MIME type. It only takes effect after the next call to upipe_set_uri.

Parameter list:

  • upipe: description structure of the pipe
  • mime: MIME type

The return value is an error code

int upipe_avfsink_set_ts_offset(struct upipe *upipe, uint64_t ts_offset) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 219.

This function sets the timestamp offset

Parameter list:

  • upipe: description structure of the pipe
  • ts_offset: timestamp offset

The return value is an error code

enum uprobe_avfsink_event [link] 

This enum is declared in upipe-av/upipe_avformat_sink.h source file, line 47.

This enum extends uprobe_event with specific events for avformat sink.

IdentifierValueDescription
UPROBE_AVFSINK_SENTINEL0x8000
UPROBE_AVFSINK_TS_OFFSET1offset between Upipe timestamp and avformat timestamp (uint64_t)

int uref_avfsink_cmp_wallclock(struct uref *uref1, struct uref *uref2) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function compares the avfsink utc wall clock attribute in two urefs.

Parameter list:

  • uref1: pointer to the first uref
  • uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

int uref_avfsink_copy_wallclock(struct uref *uref, struct uref *uref_src) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function copies the avfsink utc wall clock attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_avfsink_delete_wallclock(struct uref *uref) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function deletes the avfsink utc wall clock attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_avfsink_get_wallclock(struct uref *uref, uint64_t *p) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function returns the avfsink utc wall clock attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)

The return value is an error code

int uref_avfsink_match_wallclock(struct uref *uref, uint64_t min, uint64_t max) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function compares the avfsink utc wall clock attribute to given values.

Parameter list:

  • uref: pointer to the uref
  • min: minimum value
  • max: maximum value

The return value is an error code

int uref_avfsink_set_wallclock(struct uref *uref, uint64_t v) [link] 

This function is declared in upipe-av/upipe_avformat_sink.h source file, line 44.

This function sets the avfsink utc wall clock attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • v: value to set

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Sun Dec 14 18:31:17 2025 using MkDoc