GstSdp.MIKEYPayload¶

Fields¶

Name	Type	Access	Description
len	`int`	r/w	length of the payload
mini_object	`Gst.MiniObject`	r
type	`GstSdp.MIKEYPayloadType`	r/w	the payload type

Methods¶

class	`new` (type)
	`kemac_add_sub` (newpay)
	`kemac_get_n_sub` ()
	`kemac_get_sub` (idx)
	`kemac_remove_sub` (idx)
	`kemac_set` (enc_alg, mac_alg)
	`key_data_set_interval` (vf_len, vt_data)
	`key_data_set_key` (key_type, key_data)
	`key_data_set_salt` (salt_data)
	`key_data_set_spi` (spi_data)
	`pke_set` (C, data)
	`rand_set` (rand)
	`sp_add_param` (type, val)
	`sp_get_n_params` ()
	`sp_get_param` (idx)
	`sp_remove_param` (idx)
	`sp_set` (policy, proto)
	`t_set` (type, ts_value)

Details¶

class GstSdp.MIKEYPayload¶

Hold the common fields for all payloads

classmethod new(type)[source]¶

Parameters:	type (`GstSdp.MIKEYPayloadType`) – a `GstSdp.MIKEYPayloadType`
Returns:	a new `GstSdp.MIKEYPayload` or `None` on failure.
Return type:	`GstSdp.MIKEYPayload` or `None`

Make a new GstSdp.MIKEYPayload with type.

New in version 1.4.

kemac_add_sub(newpay)[source]¶

Parameters:	newpay (`GstSdp.MIKEYPayload`) – a `GstSdp.MIKEYPayload` to add
Returns:	`True` on success.
Return type:	`bool`

Add a new sub payload to self.

New in version 1.4.

kemac_get_n_sub()[source]¶

Returns:	the number of sub payloads in self
Return type:	`int`

Get the number of sub payloads of self. self should be of type GstSdp.MIKEYPayloadType.KEMAC.

New in version 1.4.

kemac_get_sub(idx)[source]¶

Parameters:	idx (`int`) – an index
Returns:	the `GstSdp.MIKEYPayload` at idx.
Return type:	`GstSdp.MIKEYPayload`

Get the sub payload of self at idx. self should be of type GstSdp.MIKEYPayloadType.KEMAC.

New in version 1.4.

kemac_remove_sub(idx)[source]¶

Parameters:	idx (`int`) – the index to remove
Returns:	`True` on success.
Return type:	`bool`

Remove the sub payload at idx in self.

New in version 1.4.

kemac_set(enc_alg, mac_alg)[source]¶

Parameters:	enc_alg (`GstSdp.MIKEYEncAlg`) – the `GstSdp.MIKEYEncAlg` mac_alg (`GstSdp.MIKEYMacAlg`) – a `GstSdp.MIKEYMacAlg`
Returns:	`True` on success
Return type:	`bool`

Set the KEMAC parameters. self should point to a GstSdp.MIKEYPayloadType.KEMAC payload.

New in version 1.4.

key_data_set_interval(vf_len, vt_data)[source]¶

Parameters:	vf_len (`int`) – the length of vf_data vt_data (`bytes`) – the Valid To data
Returns:	`True` on success
Return type:	`bool`

Set the key validity period in the GstSdp.MIKEYPayloadType.KEY_DATA self.

New in version 1.4.

key_data_set_key(key_type, key_data)[source]¶

Parameters:	key_type (`GstSdp.MIKEYKeyDataType`) – a `GstSdp.MIKEYKeyDataType` key_data (`bytes`) – the key of type key_type
Returns:	`True` on success
Return type:	`bool`

Set key_len bytes of key_data of type key_type as the key for the GstSdp.MIKEYPayloadType.KEY_DATA self.

New in version 1.4.

key_data_set_salt(salt_data)[source]¶

Parameters:	salt_data (`bytes` or `None`) – the salt
Returns:	`True` on success
Return type:	`bool`

Set the salt key data. If salt_len is 0 and salt_data is None, the salt data will be removed.

New in version 1.4.

key_data_set_spi(spi_data)[source]¶

Parameters:	spi_data (`bytes`) – the SPI/MKI data
Returns:	`True` on success
Return type:	`bool`

Set the SPI/MKI validity in the GstSdp.MIKEYPayloadType.KEY_DATA self.

New in version 1.4.

pke_set(C, data)[source]¶

Parameters:	C (`GstSdp.MIKEYCacheType`) – envelope key cache indicator data (`bytes`) – the encrypted envelope key
Returns:	`True` on success
Return type:	`bool`

Set the PKE values in self. self must be of type GstSdp.MIKEYPayloadType.PKE.

New in version 1.4.

rand_set(rand)[source]¶

Parameters:	rand (`bytes`) – random values
Returns:	`True` on success
Return type:	`bool`

Set the random values in a GstSdp.MIKEYPayloadType.RAND self.

New in version 1.4.

sp_add_param(type, val)[source]¶

Parameters:	type (`int`) – a type val (`bytes`) – len bytes of data
Returns:	`True` on success
Return type:	`bool`

Add a new parameter to the GstSdp.MIKEYPayloadType.SP self with type, len and val.

New in version 1.4.

sp_get_n_params()[source]¶

Returns:	the number of parameters in self
Return type:	`int`

Get the number of security policy parameters in a GstSdp.MIKEYPayloadType.SP self.

New in version 1.4.

sp_get_param(idx)[source]¶

Parameters:	idx (`int`) – an index
Returns:	the `GstSdp.MIKEYPayloadSPParam` at idx in self
Return type:	`GstSdp.MIKEYPayloadSPParam`

Get the Security Policy parameter in a GstSdp.MIKEYPayloadType.SP self at idx.

New in version 1.4.

sp_remove_param(idx)[source]¶

Parameters:	idx (`int`) – an index
Returns:	`True` on success
Return type:	`bool`

Remove the Security Policy parameters from a GstSdp.MIKEYPayloadType.SP self at idx.

New in version 1.4.

sp_set(policy, proto)[source]¶

Parameters:	policy (`int`) – the policy number proto (`GstSdp.MIKEYSecProto`) – a `GstSdp.MIKEYSecProto`
Returns:	`True` on success
Return type:	`bool`

Set the Security Policy parameters for self.

New in version 1.4.

t_set(type, ts_value)[source]¶

Parameters:	type (`GstSdp.MIKEYTSType`) – the `GstSdp.MIKEYTSType` ts_value (`bytes`) – the timestamp value
Returns:	`True` on success
Return type:	`bool`

Set the timestamp in a GstSdp.MIKEYPayloadType.T self.

New in version 1.4.