AgsAudio.SoundContainer

g AgsAudio.SoundContainer AgsAudio.SoundContainer GObject.GInterface GObject.GInterface GObject.GInterface->AgsAudio.SoundContainer

Implementations:
 AgsAudio.Ipatch, AgsAudio.SFZFile

Methods

  close ()
  get_level_count ()
  get_level_id ()
  get_level_index ()
  get_nesting_level ()
  get_resource_all ()
  get_resource_by_index (resource_index)
  get_resource_by_name (resource_name)
  get_resource_current ()
  get_sublevel_name ()
  level_up (level_count)
  open (filename)
  select_level_by_id (level_id)
  select_level_by_index (level_index)

Virtual Methods

  do_close ()
  do_get_level_count ()
  do_get_level_id ()
  do_get_level_index ()
  do_get_nesting_level ()
  do_get_resource_all ()
  do_get_resource_by_index (resource_index)
  do_get_resource_by_name (resource_name)
  do_get_resource_current ()
  do_get_sublevel_name ()
  do_level_up (level_count)
  do_open (filename)
  do_select_level_by_id (level_id)
  do_select_level_by_index (level_index)

Properties

None

Signals

None

Fields

None

Class Details

class AgsAudio.SoundContainer
Bases:GObject.GInterface
Structure:AgsAudio.SoundContainerInterface
close()

Close self.

New in version 3.0.0.

get_level_count()
Returns:the level count
Return type:int

Get level count.

New in version 3.0.0.

get_level_id()
Returns:the level id as string
Return type:str

Get level id.

New in version 3.0.0.

get_level_index()
Returns:the level index unsigned integer
Return type:int

Get level index.

New in version 3.0.0.

get_nesting_level()
Returns:the nesting level
Return type:int

Get nesting level.

New in version 3.0.0.

get_resource_all()
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get all resources as a GLib.List-struct.

New in version 3.0.0.

get_resource_by_index(resource_index)
Parameters:resource_index (int) – the index
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by index as a GLib.List-struct.

New in version 3.0.0.

get_resource_by_name(resource_name)
Parameters:resource_name (str) – the resource name
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by name as a GLib.List-struct.

New in version 3.0.0.

get_resource_current()
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by index as a GLib.List-struct.

New in version 3.0.0.

get_sublevel_name()
Returns:the string vector containing sublevel names
Return type:[str]

Get sublevel names.

New in version 3.0.0.

level_up(level_count)
Parameters:level_count (int) – the count of levels to go up
Returns:the level count went up
Return type:int

Level up.

New in version 3.0.0.

open(filename)
Parameters:filename (str) – the filename
Returns:True if open succeeded, else False
Return type:bool

Open self.

New in version 3.0.0.

select_level_by_id(level_id)
Parameters:level_id (str) – the level id as string
Returns:the index of level as unsigned integer
Return type:int

Select level by id.

New in version 3.0.0.

select_level_by_index(level_index)
Parameters:level_index (int) – the level index unsigned integer
Returns:the index of level as unsigned integer
Return type:int

Select level by index.

New in version 3.0.0.

do_close() virtual

Close sound_container.

New in version 3.0.0.

do_get_level_count() virtual
Returns:the level count
Return type:int

Get level count.

New in version 3.0.0.

do_get_level_id() virtual
Returns:the level id as string
Return type:str

Get level id.

New in version 3.0.0.

do_get_level_index() virtual
Returns:the level index unsigned integer
Return type:int

Get level index.

New in version 3.0.0.

do_get_nesting_level() virtual
Returns:the nesting level
Return type:int

Get nesting level.

New in version 3.0.0.

do_get_resource_all() virtual
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get all resources as a GLib.List-struct.

New in version 3.0.0.

do_get_resource_by_index(resource_index) virtual
Parameters:resource_index (int) – the index
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by index as a GLib.List-struct.

New in version 3.0.0.

do_get_resource_by_name(resource_name) virtual
Parameters:resource_name (str) – the resource name
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by name as a GLib.List-struct.

New in version 3.0.0.

do_get_resource_current() virtual
Returns:the GLib.List-struct containing #AgsResource
Return type:[GObject.Object]

Get resources by index as a GLib.List-struct.

New in version 3.0.0.

do_get_sublevel_name() virtual
Returns:the string vector containing sublevel names
Return type:[str]

Get sublevel names.

New in version 3.0.0.

do_level_up(level_count) virtual
Parameters:level_count (int) – the count of levels to go up
Returns:the level count went up
Return type:int

Level up.

New in version 3.0.0.

do_open(filename) virtual
Parameters:filename (str) – the filename
Returns:True if open succeeded, else False
Return type:bool

Open sound_container.

New in version 3.0.0.

do_select_level_by_id(level_id) virtual
Parameters:level_id (str) – the level id as string
Returns:the index of level as unsigned integer
Return type:int

Select level by id.

New in version 3.0.0.

do_select_level_by_index(level_index) virtual
Parameters:level_index (int) – the level index unsigned integer
Returns:the index of level as unsigned integer
Return type:int

Select level by index.

New in version 3.0.0.