Class: Vk::API::Audio

Inherits:
Schema::Namespace show all
Defined in:
lib/vk/api/methods.rb,
lib/vk/api/objects.rb,
lib/vk/api/responses.rb,
lib/vk/api/audio/audio.rb,
lib/vk/api/audio/lyrics.rb,
lib/vk/api/audio/audio_full.rb,
lib/vk/api/audio/audio_album.rb,
lib/vk/api/audio/methods/add.rb,
lib/vk/api/audio/methods/get.rb,
lib/vk/api/audio/methods/edit.rb,
lib/vk/api/audio/methods/save.rb,
lib/vk/api/audio/methods/delete.rb,
lib/vk/api/audio/methods/search.rb,
lib/vk/api/audio/methods/reorder.rb,
lib/vk/api/audio/methods/restore.rb,
lib/vk/api/audio/methods/add_album.rb,
lib/vk/api/audio/methods/get_by_id.rb,
lib/vk/api/audio/methods/get_count.rb,
lib/vk/api/audio/methods/edit_album.rb,
lib/vk/api/audio/methods/get_albums.rb,
lib/vk/api/audio/methods/get_lyrics.rb,
lib/vk/api/audio/methods/get_popular.rb,
lib/vk/api/audio/methods/delete_album.rb,
lib/vk/api/audio/audio_upload_response.rb,
lib/vk/api/audio/methods/move_to_album.rb,
lib/vk/api/audio/methods/set_broadcast.rb,
lib/vk/api/audio/responses/add_response.rb,
lib/vk/api/audio/responses/get_response.rb,
lib/vk/api/audio/responses/edit_response.rb,
lib/vk/api/audio/responses/save_response.rb,
lib/vk/api/audio/methods/get_upload_server.rb,
lib/vk/api/audio/responses/delete_response.rb,
lib/vk/api/audio/responses/search_response.rb,
lib/vk/api/audio/methods/get_broadcast_list.rb,
lib/vk/api/audio/responses/reorder_response.rb,
lib/vk/api/audio/responses/restore_response.rb,
lib/vk/api/audio/methods/get_recommendations.rb,
lib/vk/api/audio/responses/add_album_response.rb,
lib/vk/api/audio/responses/get_by_id_response.rb,
lib/vk/api/audio/responses/get_count_response.rb,
lib/vk/api/audio/responses/edit_album_response.rb,
lib/vk/api/audio/responses/get_albums_response.rb,
lib/vk/api/audio/responses/get_lyrics_response.rb,
lib/vk/api/audio/responses/get_popular_response.rb,
lib/vk/api/audio/responses/delete_album_response.rb,
lib/vk/api/audio/responses/move_to_album_response.rb,
lib/vk/api/audio/responses/set_broadcast_response.rb,
lib/vk/api/audio/responses/get_upload_server_response.rb,
lib/vk/api/audio/responses/get_broadcast_list_response.rb,
lib/vk/api/audio/responses/get_recommendations_response.rb

Defined Under Namespace

Modules: Methods, Responses Classes: Audio, AudioAlbum, AudioFull, AudioUploadResponse, Lyrics

Instance Attribute Summary

Attributes inherited from Schema::Namespace

#client

DSL collapse

Methods inherited from Schema::Namespace

#call, #initialize

Constructor Details

This class inherits a constructor from Vk::Schema::Namespace

Instance Method Details

#add(arguments = {}) ⇒ Vk::API::Audio::Responses::AddResponse

Returns Copies an audio file to a user page or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audio_id (Integer) —

    Audio file ID.

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file. Use a negative value to designate a community ID. ; ;

  • :group_id (Integer) —

    Community ID, needed when adding the audio file to a community (without minus).

  • :album_id (Integer) —

    Album ID.

Returns:

See Also:



1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/vk/api/methods.rb', line 1909

def add(arguments = {})
  require "vk/api/audio/methods/add"
  method = Methods::Add.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/add_response"
  Responses::AddResponse.new(response.deep_symbolize_keys)
end

#add_album(arguments = {}) ⇒ Vk::API::Audio::Responses::AddAlbumResponse

Returns Creates an empty audio album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer) —

    Community ID (if the album will be created in a community).

  • :title (String) —

    Album title.

Returns:

See Also:



1989
1990
1991
1992
1993
1994
1995
 
# File 'lib/vk/api/methods.rb', line 1989

def add_album(arguments = {})
  require "vk/api/audio/methods/add_album"
  method = Methods::AddAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/add_album_response"
  Responses::AddAlbumResponse.new(response.deep_symbolize_keys)
end

#delete(arguments = {}) ⇒ Vk::API::Audio::Responses::DeleteResponse

Returns Deletes an audio file from a user page or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audio_id (Integer) —

    Audio file ID.

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file. Use a negative value to designate a community ID.

Returns:

See Also:



1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/vk/api/methods.rb', line 1921

def delete(arguments = {})
  require "vk/api/audio/methods/delete"
  method = Methods::Delete.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/delete_response"
  Responses::DeleteResponse.new(response.deep_symbolize_keys)
end

#delete_album(arguments = {}) ⇒ Vk::API::Audio::Responses::DeleteAlbumResponse

Returns Deletes an audio album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer) —

    ID of the community where the album is located.;

  • :album_id (Integer) —

    Album ID.

Returns:

See Also:



2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/vk/api/methods.rb', line 2014

def delete_album(arguments = {})
  require "vk/api/audio/methods/delete_album"
  method = Methods::DeleteAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/delete_album_response"
  Responses::DeleteAlbumResponse.new(response.deep_symbolize_keys)
end

#edit(arguments = {}) ⇒ Vk::API::Audio::Responses::EditResponse

Returns Edits an audio file on a user or community page.;.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file.

  • :audio_id (Integer) —

    Audio file ID.

  • :artist (String) —

    Name of the artist.

  • :title (String) —

    Title of the audio file.

  • :text (String) —

    Text of the lyrics of the audio file.

  • :genre_id (Integer) —

    Genre of the audio file. See the list of .

  • :no_search (Boolean) —

    '1' — audio file will not be available for search; '0' — audio file will be available for search (default)

Returns:

See Also:



1938
1939
1940
1941
1942
1943
1944
 
# File 'lib/vk/api/methods.rb', line 1938

def edit(arguments = {})
  require "vk/api/audio/methods/edit"
  method = Methods::Edit.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/edit_response"
  Responses::EditResponse.new(response.deep_symbolize_keys)
end

#edit_album(arguments = {}) ⇒ Vk::API::Audio::Responses::EditAlbumResponse

Returns Edits the title of an audio album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer) —

    ID of the community where the album is located.;

  • :album_id (Integer) —

    Album ID.

  • :title (String) —

    New album title.

Returns:

See Also:



2002
2003
2004
2005
2006
2007
2008
 
# File 'lib/vk/api/methods.rb', line 2002

def edit_album(arguments = {})
  require "vk/api/audio/methods/edit_album"
  method = Methods::EditAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/edit_album_response"
  Responses::EditAlbumResponse.new(response.deep_symbolize_keys)
end

#get(arguments = {}) ⇒ Vk::API::Audio::Responses::GetResponse

Returns a list of audio files of a user or community.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file. Use a negative value to designate a community ID.

  • :album_id (Integer) —

    Audio album ID.

  • :audio_ids (Array) —

    IDs of the audio files to return.

  • :need_user (Boolean) —

    '1' — to return information about users who uploaded audio files

  • :offset (Integer) —

    Offset needed to return a specific subset of audio files.

  • :count (Integer) —

    Number of audio files to return.

Returns:

See Also:



1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/vk/api/methods.rb', line 1830

def get(arguments = {})
  require "vk/api/audio/methods/get"
  method = Methods::Get.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_response"
  Responses::GetResponse.new(response.deep_symbolize_keys)
end

#get_albums(arguments = {}) ⇒ Vk::API::Audio::Responses::GetAlbumsResponse

Returns a list of audio albums of a user or community.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file.

  • :offset (Integer) —

    Offset needed to return a specific subset of albums.

  • :count (Integer) — default: 50 —

    Number of albums to return.

Returns:

See Also:



1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/vk/api/methods.rb', line 1977

def get_albums(arguments = {})
  require "vk/api/audio/methods/get_albums"
  method = Methods::GetAlbums.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_albums_response"
  Responses::GetAlbumsResponse.new(response.deep_symbolize_keys)
end

#get_broadcast_list(arguments = {}) ⇒ Vk::API::Audio::Responses::GetBroadcastListResponse

Returns a list of the user's friends and communities that are broadcasting music in their statuses.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :filter (String) — default: "all" —

    Types of objects to return:; 'friends' — only friends; 'groups' — only communities; 'all' — both friends and communities (default)

  • :active (Boolean) —

    '1' — to return only friends and communities that are broadcasting at the moment.; '0' — to return all friends and communities (default).

Returns:

See Also:



2051
2052
2053
2054
2055
2056
2057
 
# File 'lib/vk/api/methods.rb', line 2051

def get_broadcast_list(arguments = {})
  require "vk/api/audio/methods/get_broadcast_list"
  method = Methods::GetBroadcastList.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_broadcast_list_response"
  Responses::GetBroadcastListResponse.new(response.deep_symbolize_keys)
end

#get_by_id(arguments = {}) ⇒ Vk::API::Audio::Responses::GetByIdResponse

Returns information about audio files by their IDs.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audios (Array) —

    Audio file IDs, in the following format:; "\$1owner_id\$1_\$1audio_id\$1"

Returns:

See Also:



1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/vk/api/methods.rb', line 1841

def get_by_id(arguments = {})
  require "vk/api/audio/methods/get_by_id"
  method = Methods::GetById.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_by_id_response"
  Responses::GetByIdResponse.new(response.deep_symbolize_keys)
end

#get_count(arguments = {}) ⇒ Vk::API::Audio::Responses::GetCountResponse

Returns the total number of audio files on a user or community page.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of the user or community that owns the audio files. By default, current user ID.

Returns:

See Also:



2091
2092
2093
2094
2095
2096
2097
 
# File 'lib/vk/api/methods.rb', line 2091

def get_count(arguments = {})
  require "vk/api/audio/methods/get_count"
  method = Methods::GetCount.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_count_response"
  Responses::GetCountResponse.new(response.deep_symbolize_keys)
end

#get_lyrics(arguments = {}) ⇒ Vk::API::Audio::Responses::GetLyricsResponse

Returns lyrics associated with an audio file.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :lyrics_id (Integer) —

    Lyrics ID (could be obtained with , , or methods).

Returns:

See Also:



1852
1853
1854
1855
1856
1857
1858
 
# File 'lib/vk/api/methods.rb', line 1852

def get_lyrics(arguments = {})
  require "vk/api/audio/methods/get_lyrics"
  method = Methods::GetLyrics.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_lyrics_response"
  Responses::GetLyricsResponse.new(response.deep_symbolize_keys)
end

#get_popular(arguments = {}) ⇒ Vk::API::Audio::Responses::GetPopularResponse

Returns a list of audio files from the "Popular".

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :only_eng (Boolean) —

    '1' — to return only foreign audio files; '0' — to return all audio files;

  • :genre_id (Integer) —

    Genre ID. See .

  • :offset (Integer) —

    Offset needed to return a specific subset of audio files.

  • :count (Integer) — default: 100 —

    Number of audio files to return.

Returns:

See Also:



2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/vk/api/methods.rb', line 2080

def get_popular(arguments = {})
  require "vk/api/audio/methods/get_popular"
  method = Methods::GetPopular.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_popular_response"
  Responses::GetPopularResponse.new(response.deep_symbolize_keys)
end

#get_recommendations(arguments = {}) ⇒ Vk::API::Audio::Responses::GetRecommendationsResponse

Returns a list of suggested audio files based on a user's playlist or a particular audio file.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :target_audio (String) —

    Use to get recommendations based on a particular audio file. The ID of the user or community that owns an audio file and that audio file's ID, separated by an underscore.;

  • :user_id (Integer) —

    Use to get recommendations based on a user's playlist. User ID. By default, the current user ID.;

  • :offset (Integer) —

    Offset needed to return a specific subset of audio files.

  • :count (Integer) — default: 100 —

    Number of audio files to return.

  • :shuffle (Boolean) —

    '1' — shuffle on

Returns:

See Also:



2066
2067
2068
2069
2070
2071
2072
 
# File 'lib/vk/api/methods.rb', line 2066

def get_recommendations(arguments = {})
  require "vk/api/audio/methods/get_recommendations"
  method = Methods::GetRecommendations.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_recommendations_response"
  Responses::GetRecommendationsResponse.new(response.deep_symbolize_keys)
end

#get_upload_server(arguments = {}) ⇒ Vk::API::Audio::Responses::GetUploadServerResponse

Returns the server address to [https://vk.com/dev/upload_files_2?f=8.%20Uploading%20Audio%20Files|upload audio files].

Parameters:

  • arguments (Hash) (defaults to: {})

Returns:

See Also:



1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/vk/api/methods.rb', line 1880

def get_upload_server(arguments = {})
  require "vk/api/audio/methods/get_upload_server"
  method = Methods::GetUploadServer.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/get_upload_server_response"
  Responses::GetUploadServerResponse.new(response.deep_symbolize_keys)
end

#move_to_album(arguments = {}) ⇒ Vk::API::Audio::Responses::MoveToAlbumResponse

Returns Moves audio files to an album.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :group_id (Integer) —

    ID of the community where the audio files are located. By default, current user ID.;

  • :album_id (Integer) —

    ID of the album to which the audio files will be moved.

  • :audio_ids (Array) —

    IDs of the audio files to be moved.; "NOTE: An album can hold up to 1000 audio files.";

Returns:

See Also:



2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/vk/api/methods.rb', line 2027

def move_to_album(arguments = {})
  require "vk/api/audio/methods/move_to_album"
  method = Methods::MoveToAlbum.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/move_to_album_response"
  Responses::MoveToAlbumResponse.new(response.deep_symbolize_keys)
end

#reorder(arguments = {}) ⇒ Vk::API::Audio::Responses::ReorderResponse

Returns Reorders an audio file, placing it between other specified audio files.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audio_id (Integer) —

    Audio file ID.

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file.

  • :before (Integer) —

    ID of the audio file before which to place the audio file.

  • :after (Integer) —

    ID of the audio file after which to place the audio file.

Returns:

See Also:



1952
1953
1954
1955
1956
1957
1958
 
# File 'lib/vk/api/methods.rb', line 1952

def reorder(arguments = {})
  require "vk/api/audio/methods/reorder"
  method = Methods::Reorder.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/reorder_response"
  Responses::ReorderResponse.new(response.deep_symbolize_keys)
end

#restore(arguments = {}) ⇒ Vk::API::Audio::Responses::RestoreResponse

Returns Restores a audio file.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audio_id (Integer) —

    Audio file ID.

  • :owner_id (Integer) —

    ID of the user or community that owns the audio file.

Returns:

See Also:



1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/vk/api/methods.rb', line 1964

def restore(arguments = {})
  require "vk/api/audio/methods/restore"
  method = Methods::Restore.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/restore_response"
  Responses::RestoreResponse.new(response.deep_symbolize_keys)
end

#save(arguments = {}) ⇒ Vk::API::Audio::Responses::SaveResponse

Returns Saves audio files after successful [https://vk.com/dev/upload_files_2?f=8.%20Uploading%20Audio%20Files|uploading].

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

Returns:

See Also:



1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/vk/api/methods.rb', line 1895

def save(arguments = {})
  require "vk/api/audio/methods/save"
  method = Methods::Save.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/save_response"
  Responses::SaveResponse.new(response.deep_symbolize_keys)
end

#search(arguments = {}) ⇒ Vk::API::Audio::Responses::SearchResponse

Returns a list of audio matching the search criteria.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :q (String) —

    Search query string (e.g., 'The Beatles').

  • :auto_complete (Boolean) —

    '1' — to correct for mistakes in the search query (e.g., if you enter 'Beetles', the system will search for 'Beatles').

  • :lyrics (Boolean) —

    '1' — to return only audio files that have associated lyrics.

  • :performer_only (Boolean) —

    '1' — to search only by artist name.

  • :sort (Integer) —

    Sort order: ; '1' — by duration;; '2' — by popularity;; '0' — by date added.

  • :search_own (Boolean) —

    '1' — to search among current user's audios. By default: '0'.

  • :offset (Integer) —

    Offset needed to return a specific subset of audio files.

  • :count (Integer) — default: 30 —

    Number of audio files to return.

Returns:

See Also:



1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/vk/api/methods.rb', line 1870

def search(arguments = {})
  require "vk/api/audio/methods/search"
  method = Methods::Search.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/search_response"
  Responses::SearchResponse.new(response.deep_symbolize_keys)
end

#set_broadcast(arguments = {}) ⇒ Vk::API::Audio::Responses::SetBroadcastResponse

Returns Activates an audio broadcast to the status of a user or community.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :audio (String) —

    ID of the audio file to be shown in status (e.g., '1_190442705'). If the parameter is not set, the audio status of given communities and user will be deleted.

  • :target_ids (Array) —

    IDs of communities and user whose statuses will be included in the broadcast. Use a negative value to designate a community ID. By default, current user ID.

Returns:

See Also:



2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/vk/api/methods.rb', line 2039

def set_broadcast(arguments = {})
  require "vk/api/audio/methods/set_broadcast"
  method = Methods::SetBroadcast.new(arguments)
  response = method.call(@client)
  require "vk/api/audio/responses/set_broadcast_response"
  Responses::SetBroadcastResponse.new(response.deep_symbolize_keys)
end