The Preset Service Interface. More...
Public Member Functions | |
| bool | Add (Preset preset) |
| Add a new preset to the system. | |
| void | Update (Preset update) |
| Update a preset. | |
| void | Remove (Preset preset) |
| Remove a preset with a given name from either the built in or user preset list. | |
| void | RemoveGroup (string category) |
| Remove a group of presets by category. | |
| Preset | GetPreset (string name) |
| Get a Preset. | |
| void | ClearBuiltIn () |
| Clear Built-in Presets. | |
| void | ClearAll () |
| Clear all presets. | |
| void | SetDefault (Preset name) |
| Set Default Preset. | |
| bool | CanUpdatePreset (string name) |
| Returns a value if the preset can be updated / resaved. | |
| void | UpdateBuiltInPresets () |
| Reads the CLI's CLI output format and load's them into the preset List Preset. | |
| bool | CheckIfPresetsAreOutOfDate () |
| Check if the built in Presets stored are not out of date. Update them if they are. | |
| bool | CheckIfPresetExists (string name) |
| Check if the preset "name" exists in either Presets or UserPresets lists. | |
Properties | |
| ObservableCollection< Preset > | Presets [get] |
| Gets a Collection of presets. | |
| Preset | DefaultPreset [get] |
| Gets DefaultPreset. | |
Detailed Description
The Preset Service Interface.
Member Function Documentation
| bool HandBrake::ApplicationServices::Services::Interfaces::IPresetService::Add | ( | Preset | preset | ) |
Add a new preset to the system.
- Parameters:
-
preset A Preset to add
- Returns:
- True if added, False if name already exists
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| bool HandBrake::ApplicationServices::Services::Interfaces::IPresetService::CanUpdatePreset | ( | string | name | ) |
Returns a value if the preset can be updated / resaved.
- Parameters:
-
name The name.
- Returns:
- True if it's not a built-in preset, false otherwise.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| bool HandBrake::ApplicationServices::Services::Interfaces::IPresetService::CheckIfPresetExists | ( | string | name | ) |
Check if the preset "name" exists in either Presets or UserPresets lists.
- Parameters:
-
name Name of the preset
- Returns:
- True if found
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| bool HandBrake::ApplicationServices::Services::Interfaces::IPresetService::CheckIfPresetsAreOutOfDate | ( | ) |
Check if the built in Presets stored are not out of date. Update them if they are.
- Returns:
- true if out of date
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::ClearAll | ( | ) |
Clear all presets.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::ClearBuiltIn | ( | ) |
Clear Built-in Presets.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| Preset HandBrake::ApplicationServices::Services::Interfaces::IPresetService::GetPreset | ( | string | name | ) |
Get a Preset.
- Parameters:
-
name The name of the preset to get
- Returns:
- A Preset or null object
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::Remove | ( | Preset | preset | ) |
Remove a preset with a given name from either the built in or user preset list.
- Parameters:
-
preset The Preset to remove
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::RemoveGroup | ( | string | category | ) |
Remove a group of presets by category.
- Parameters:
-
category The Category to remove
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::SetDefault | ( | Preset | name | ) |
Set Default Preset.
- Parameters:
-
name The name.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::Update | ( | Preset | update | ) |
Update a preset.
- Parameters:
-
update The updated preset
Implemented in HandBrake::ApplicationServices::Services::PresetService.
| void HandBrake::ApplicationServices::Services::Interfaces::IPresetService::UpdateBuiltInPresets | ( | ) |
Reads the CLI's CLI output format and load's them into the preset List Preset.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
Property Documentation
Preset HandBrake::ApplicationServices::Services::Interfaces::IPresetService::DefaultPreset [get] |
Gets DefaultPreset.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
ObservableCollection<Preset> HandBrake::ApplicationServices::Services::Interfaces::IPresetService::Presets [get] |
Gets a Collection of presets.
Implemented in HandBrake::ApplicationServices::Services::PresetService.
The documentation for this interface was generated from the following file:
- win/CS/HandBrake.ApplicationServices/Services/Interfaces/IPresetService.cs
Generated on Tue May 21 2013 05:32:04 for HandBrake by
1.7.1