Interface

Gst-1.0 ▶ Gst ▶ Preset ▶ Interface

Interface for implementing Preset. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_delete_preset(name: string): boolean;
    vfunc_get_meta(name: string, tag: string): [boolean, string];
    vfunc_get_preset_names(): string[];
    vfunc_get_property_names(): string[];
    vfunc_load_preset(name: string): boolean;
    vfunc_rename_preset(old_name: string, new_name: string): boolean;
    vfunc_save_preset(name: string): boolean;
    vfunc_set_meta(name: string, tag: string, value?: string): boolean;
}

Hierarchy (View Summary)

Index

Methods

vfunc_delete_preset vfunc_get_meta vfunc_get_preset_names vfunc_get_property_names vfunc_load_preset vfunc_rename_preset vfunc_save_preset vfunc_set_meta

Methods

  • Delete the given preset.

    Parameters

    • name: string

      preset name to remove

    Returns boolean

  • Gets the value for an existing meta data tag. Meta data tag names can be something like e.g. "comment". Returned values need to be released when done.

    Parameters

    • name: string

      preset name

    • tag: string

      meta data item name

    Returns [boolean, string]

  • Get a copy of preset names as a null terminated string array.

    Returns string[]

  • Get a the names of the GObject properties that can be used for presets.

    Returns string[]

  • Load the given preset.

    Parameters

    • name: string

      preset name to load

    Returns boolean

  • Renames a preset. If there is already a preset by the new_name it will be overwritten.

    Parameters

    • old_name: string

      current preset name

    • new_name: string

      new preset name

    Returns boolean

  • Save the current object settings as a preset under the given name. If there is already a preset by this name it will be overwritten.

    Parameters

    • name: string

      preset name to save

    Returns boolean

  • Sets a new value for an existing meta data item or adds a new item. Meta data tag names can be something like e.g. "comment". Supplying null for the value will unset an existing value.

    Parameters

    • name: string

      preset name

    • tag: string

      meta data item name

    • Optionalvalue: string

      new value

    Returns boolean