upipe-dvbcsa/upipe_dvbcsa_common.h header reference

Header inclusion  

Members  

Types  

Functions  

Macro  

Members detail  

#define UPIPE_DVBCSA_COMMON_SIGNATURE  

This macro is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 37.

This macro is the signature for common dvbcsa pipe operations.

#define _UPIPE_DVBCSA_UPIPE_DVBCSA_COMMON_H_  

This macro is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 26.

int upipe_dvbcsa_add_pid(struct upipe *upipe, uint64_t pid)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 92.

This function adds a pid to the encryption/decryption list.

Parameter list:

  • upipe: description structure of the pipe
  • pid: pid to add

The return value is an error code

enum upipe_dvbcsa_command  

This enum is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 41.

This enum enumerates the common custom control commands.

IdentifierValueDescription
UPIPE_DVBCSA_SENTINELUPIPE_CONTROL_LOCALsentinel
UPIPE_DVBCSA_SET_KEYunknownset the dvbcsa key (const char *)
UPIPE_DVBCSA_SET_MAX_LATENCYunknownset the maximum latency (uint64_t)
UPIPE_DVBCSA_ADD_PIDunknownadd a pid to the encryption/decryption list (uint64_t)
UPIPE_DVBCSA_DEL_PIDunknowndelete a pid from the encryption/decryption list (uint64_t)
UPIPE_DVBCSA_CONTROL_LOCALunknowncustom dvbcsa commands start here

int upipe_dvbcsa_del_pid(struct upipe *upipe, uint64_t pid)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 105.

This function deletes a pid from the encryption/decryption list.

Parameter list:

  • upipe: description structure of the pipe
  • pid: pid to delete

The return value is an error code

int upipe_dvbcsa_set_key(struct upipe *upipe, const char *key)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 66.

This function sets the dvbcsa key.

Parameter list:

  • upipe: description structure of the pipe
  • key: dvbcsa key

The return value is an error code

int upipe_dvbcsa_set_max_latency(struct upipe *upipe, uint64_t latency)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 79.

This function sets the maximum latency of the pipe.

Parameter list:

  • upipe: description structure of the pipe
  • latency: maximum latency

The return value is an error code

struct ustring_dvbcsa_cw  

This struct is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 111.

This struct stores a parsed dvbcsa control word.

FieldDescription
struct ustring str;matching part of the string
dvbcsa_cw_t value;value of the parsed control word

struct ustring_dvbcsa_cw ustring_to_dvbcsa_cw(const struct ustring str)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 183.

This function parsed a dvbcsa control word from an ustring.

Parameter list:

  • str: string to parse from

The return value is a parsed control word

struct ustring_dvbcsa_cw ustring_to_dvbcsa_cw48(const struct ustring str)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 155.

This function parsed a 48 bits dvbcsa control word from an ustring.

Parameter list:

  • str: string to parse from

The return value is a parsed control word

struct ustring_dvbcsa_cw ustring_to_dvbcsa_cw64(const struct ustring str)  

This function is declared in upipe-dvbcsa/upipe_dvbcsa_common.h source file, line 125.

This function parse a 64 bits dvbcsa control word from an ustring.

Parameter list:

  • str: string to parse from

The return value is a parsed control word

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc