GstPbutils.EncodingTarget¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
None
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class GstPbutils.EncodingTarget(**kwargs)¶
- Bases:
- Abstract:
No
Collection of
GstPbutils.EncodingProfile
for a specific target or use-case.When being stored/loaded, targets come from a specific category, like
GstPbutils.ENCODING_CATEGORY_DEVICE
.- classmethod load(name, category)[source]¶
- Parameters:
name (
str
) – the name of theGstPbutils.EncodingTarget
to load (automatically converted to lower case internally as capital letters are not valid for target names).category (
str
orNone
) – the name of the target category, likeGstPbutils.ENCODING_CATEGORY_DEVICE
. Can beNone
- Raises:
- Returns:
The
GstPbutils.EncodingTarget
if available, elseNone
.- Return type:
Searches for the
GstPbutils.EncodingTarget
with the given name, loads it and returns it.If the category name is specified only targets from that category will be searched for.
- classmethod load_from_file(filepath)[source]¶
- Parameters:
filepath (
str
) – The file location to load theGstPbutils.EncodingTarget
from- Raises:
- Returns:
The
GstPbutils.EncodingTarget
contained in the file, elseNone
- Return type:
Opens the provided file and returns the contained
GstPbutils.EncodingTarget
.
- classmethod new(name, category, description, profiles)[source]¶
- Parameters:
name (
str
) – The name of the target.category (
str
) – The name of the category to which this target belongs. For example:GstPbutils.ENCODING_CATEGORY_DEVICE
.description (
str
) – A description ofGstPbutils.EncodingTarget
in the current locale.profiles ([
GstPbutils.EncodingProfile
]) – AGLib.List
ofGstPbutils.EncodingProfile
.
- Returns:
The newly created
GstPbutils.EncodingTarget
orNone
if there was an error.- Return type:
Creates a new
GstPbutils.EncodingTarget
.The name and category can only consist of lowercase ASCII letters for the first character, followed by either lowercase ASCII letters, digits or hyphens (‘-‘).
The category *should* be one of the existing well-defined categories, like
GstPbutils.ENCODING_CATEGORY_DEVICE
, but it *can* be a application or user specific category if needed.
- add_profile(profile)[source]¶
- Parameters:
profile (
GstPbutils.EncodingProfile
) – theGstPbutils.EncodingProfile
to add- Returns:
- Return type:
Adds the given profile to the self. Each added profile must have a unique name within the profile.
The self will steal a reference to the profile. If you wish to use the profile after calling this method, you should increase its reference count.
- get_category()[source]¶
- Returns:
The category of the self. For example:
GstPbutils.ENCODING_CATEGORY_DEVICE
.- Return type:
- get_profile(name)[source]¶
- Parameters:
name (
str
) – the name of the profile to retrieve- Returns:
The matching
GstPbutils.EncodingProfile
, orNone
.- Return type:
- get_profiles()[source]¶
- Returns:
A list of
GstPbutils.EncodingProfile
(s) this self handles.- Return type: