upipe-modules/upipe_multicat_sink.h header reference

Upipe module - multicat file sink More

• upipe/ubase.h
• upipe/upipe.h
• upipe/uref_block.h
• upipe-modules/upipe_file_sink.h

• enum upipe_multicat_sink_command

• int upipe_multicat_sink_get_fsink_mgr(struct upipe *upipe, struct upipe_mgr *fsink_mgr)
• int upipe_multicat_sink_get_path(struct upipe *upipe, const char **path_p, const char **suffix_p)
• int upipe_multicat_sink_get_rotate(struct upipe *upipe, uint64_t *interval_p, uint64_t *offset_p)
• struct upipe_mgr * upipe_multicat_sink_mgr_alloc(void )
• int upipe_multicat_sink_set_fsink_mgr(struct upipe *upipe, struct upipe_mgr *fsink_mgr)
• int upipe_multicat_sink_set_mode(struct upipe *upipe, enum upipe_fsink_mode mode)
• int upipe_multicat_sink_set_path(struct upipe *upipe, const char *path, const char *suffix)
• int upipe_multicat_sink_set_rotate(struct upipe *upipe, uint64_t interval, uint64_t offset)

This sink module owns an embedded file sink and changes its path depending on the uref cr_sys attribute.

This macro is declared in upipe-modules/upipe_multicat_sink.h source file, line 45.

This macro is declared in upipe-modules/upipe_multicat_sink.h source file, line 46.

This macro is declared in upipe-modules/upipe_multicat_sink.h source file, line 44.

This macro is declared in upipe-modules/upipe_multicat_sink.h source file, line 33.

This enum is declared in upipe-modules/upipe_multicat_sink.h source file, line 50.

This enum extends upipe_command with specific commands for multicat sink.

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 162.

This function returns the fsink manager.

Parameter list:

• upipe: description structure of the pipe
• fsink_mgr: fsink manager

The return value is an error code

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 86.

This function returns the path of the currently opened node.

Parameter list:

• upipe: description structure of the pipe
• path_p: filled in with the path of the file
• suffix_p: filled in with the suffix used

The return value is an error code

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 116.

This function returns the rotate interval (in 27MHz unit).

Parameter list:

• upipe: description structure of the pipe
• interval_p: filled in with the rotate interval in 27MHz
• offset_p: filled in with the rotate offset in 27MHz

The return value is an error code

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 74.

This function returns the management structure for multicat_sink pipes.

The return value is pointer to manager

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 176.

This function sets the fsink manager.

Parameter list:

• upipe: description structure of the pipe
• fsink_mgr: fsink manager

The return value is an error code

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 148.

This function changes the open mode starting from the next open(). It does NOT reopen the current file. (default UPIPE_FSINK_APPEND)

Parameter list:

• upipe: description structure of the pipe
• mode: fsink mode

The return value is an error code

See also enum upipe_fsink_mode.

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 101.

This function asks to open the given file.

Parameter list:

• upipe: description structure of the pipe
• path: relative or absolute path of the node
• suffix: suffix to add to file names

The return value is an error code

This function is declared in upipe-modules/upipe_multicat_sink.h source file, line 132.

This function changes the rotate interval (in 27MHz unit) (default: UPIPE_MULTICAT_SINK_DEF_ROTATE).

Parameter list:

• upipe: description structure of the pipe
• interval: rotate interval in 27Mhz
• offset: rotate offset in 27Mhz

The return value is an error code