C# Class VkNet.Categories.AudioCategory

Методы для работы с аудиозаписями.

Afficher le fichier Open project: vknet/vk Class Usage Examples

Méthodes publiques

Méthode	Description
Add ( long audioId, long ownerId, long groupId = null, long albumId = null, long captchaSid = null, string captchaKey = null ) : long	Копирует аудиозапись на страницу пользователя или группы. Страница документации ВКонтакте .
AddAlbum ( string title, long groupId = null ) : long	Создает пустой альбом аудиозаписей. Страница документации ВКонтакте .
AudioCategory ( VkApi vk ) : System	Методы для работы с аудиозаписями.
Delete ( long audioId, long ownerId ) : bool	Удаляет аудиозапись со страницы пользователя или сообщества. Страница документации ВКонтакте .
DeleteAlbum ( long albumId, long groupId = null ) : bool	Удаляет альбом аудиозаписей. Страница документации ВКонтакте .
Edit ( AudioEditParams @params ) : long	Редактирует данные аудиозаписи на странице пользователя или сообщества. Страница документации ВКонтакте .
EditAlbum ( string title, long albumId, long groupId = null ) : bool	Редактирует название альбома аудиозаписей. Страница документации ВКонтакте .
Get ( User &user, AudioGetParams @params ) : ReadOnlyCollection	Возвращает список аудиозаписей пользователя или сообщества. Страница документации ВКонтакте .
GetAlbums ( long ownerId, uint count = null, uint offset = null ) : VkCollection	Возвращает список альбомов аудиозаписей пользователя или группы. Страница документации ВКонтакте .
GetBroadcastList ( string filter = null, bool active = null ) : UserOrGroup	Возвращает список друзей и сообществ пользователя, которые транслируют музыку в статус. Страница документации ВКонтакте .
GetBroadcastListFriends ( bool active = false ) : ReadOnlyCollection	Возвращает список друзей, которые транслируют музыку в статус. Страница документации ВКонтакте .
GetBroadcastListGroup ( bool active = false ) : ReadOnlyCollection	Возвращает список сообществ пользователя, которые транслируют музыку в статус. Страница документации ВКонтакте .
GetById ( ) : ReadOnlyCollection	Возвращает информацию об аудиозаписях. Страница документации ВКонтакте .
GetById ( IEnumerable audios ) : ReadOnlyCollection	Возвращает информацию об аудиозаписях. Страница документации ВКонтакте .
GetCount ( long ownerId ) : long	Возвращает количество аудиозаписей пользователя или сообщества. Страница документации ВКонтакте .
GetLyrics ( long lyricsId ) : Lyrics	Возвращает текст аудиозаписи. Страница документации ВКонтакте .
GetPopular ( bool onlyEng = false, AudioGenre genre = null, uint count = null, uint offset = null ) : ReadOnlyCollection	Возвращает список аудиозаписей из раздела "Популярное". Страница документации ВКонтакте .
GetRecommendations ( long userId = null, uint count = null, uint offset = null, bool shuffle = true, string targetAudio = "" ) : ReadOnlyCollection	Возвращает список рекомендуемых аудиозаписей на основе списка воспроизведения заданного пользователя или на основе одной выбранной аудиозаписи. Страница документации ВКонтакте .
GetUploadServer ( ) : Uri	Возвращает адрес сервера для загрузки аудиозаписей. Страница документации ВКонтакте .
MoveToAlbum ( long albumId, IEnumerable audioIds, long groupId = null ) : bool	Перемещает аудиозаписи в альбом. Страница документации ВКонтакте .
Reorder ( long audioId, long ownerId, long before, long after ) : bool	Изменяет порядок аудиозаписи, перенося ее между аудиозаписями, идентификаторы которых переданы параметрами after и before. Страница документации ВКонтакте .
Restore ( long audioId, long ownerId = null ) : Model.Audio	Восстанавливает аудиозапись после удаления. Страница документации ВКонтакте .
Save ( string response, string artist = null, string title = null ) : Model.Audio	Сохраняет аудиозаписи после успешной загрузки. Страница документации ВКонтакте .
Search ( AudioSearchParams @params ) : VkCollection	Возвращает список аудиозаписей в соответствии с заданным критерием поиска. Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Audio. Страница документации ВКонтакте .
SetBroadcast ( string audio, IEnumerable targetIds ) : ReadOnlyCollection	Транслирует аудиозапись в статус пользователю или сообществу. Страница документации ВКонтакте .

Private Methods

Méthode	Description
Edit ( long audioId, long ownerId, string artist, string title, string text, bool noSearch = null, AudioGenre genreId = AudioGenre.Other ) : long
Get ( long uid, User &user, long albumId = null, IEnumerable aids = null, uint count = null, uint offset = null ) : ReadOnlyCollection
Get ( long uid, long albumId = null, IEnumerable aids = null, uint count = null, uint offset = null ) : ReadOnlyCollection
GetFromGroup ( long gid, long albumId = null, IEnumerable aids = null, uint count = null, uint offset = null ) : ReadOnlyCollection
Search ( AudioSearchParams @params, long &totalCount ) : ReadOnlyCollection
Search ( string query, long &totalCount, bool autoComplete = null, AudioSort sort = null, bool findLyrics = null, uint count = null, uint offset = null ) : ReadOnlyCollection
publicGet ( string paramId, long id, User &user, long albumId = null, IEnumerable aids = null, bool needUser = null, uint count = null, uint offset = null ) : ReadOnlyCollection

Method Details

Add() public méthode

Копирует аудиозапись на страницу пользователя или группы.

Страница документации ВКонтакте .

public Add ( long audioId, long ownerId, long groupId = null, long albumId = null, long captchaSid = null, string captchaKey = null ) : long
audioId	long	Идентификатор аудиозаписи. положительное число, обязательный параметр (Положительное число, обязательный параметр).
ownerId	long	Идентификатор владельца аудиозаписи (пользователь или сообщество). целое число, обязательный параметр (Целое число, обязательный параметр).
groupId	long	Идентификатор сообщества (если аудиозапись необходимо скопировать в список сообщества). целое число (Целое число).
albumId	long	Идентификатор альбома, в который нужно переместить аудиозапись. положительное число (Положительное число).
captchaSid	long	Id капчи (только если для вызова метода необходимо ввести капчу)
captchaKey	string	Текст капчи (только если для вызова метода необходимо ввести капчу)
Résultat	long

AddAlbum() public méthode

Создает пустой альбом аудиозаписей.

Страница документации ВКонтакте .

public AddAlbum ( string title, long groupId = null ) : long
title	string	Название альбома. строка, обязательный параметр (Строка, обязательный параметр).
groupId	long	Идентификатор сообщества (если альбом нужно создать в сообществе). положительное число (Положительное число).
Résultat	long

AudioCategory() public méthode

Методы для работы с аудиозаписями.

public AudioCategory ( VkApi vk ) : System
vk	VkApi	Api vk.com
Résultat	System

Delete() public méthode

Удаляет аудиозапись со страницы пользователя или сообщества.

Страница документации ВКонтакте .

public Delete ( long audioId, long ownerId ) : bool
audioId	long	Идентификатор аудиозаписи. положительное число, обязательный параметр (Положительное число, обязательный параметр).
ownerId	long	Идентификатор владельца аудиозаписи (пользователь или сообщество). целое число, обязательный параметр (Целое число, обязательный параметр).
Résultat	bool

DeleteAlbum() public méthode

Удаляет альбом аудиозаписей.

Страница документации ВКонтакте .

public DeleteAlbum ( long albumId, long groupId = null ) : bool
albumId	long	Идентификатор альбома. положительное число, обязательный параметр (Положительное число, обязательный параметр).
groupId	long	Идентификатор сообщества, которому принадлежит альбом. положительное число (Положительное число).
Résultat	bool

Edit() public méthode

Редактирует данные аудиозаписи на странице пользователя или сообщества.

Страница документации ВКонтакте .

public Edit ( AudioEditParams @params ) : long
@params	AudioEditParams
Résultat	long

EditAlbum() public méthode

Редактирует название альбома аудиозаписей.

Страница документации ВКонтакте .

public EditAlbum ( string title, long albumId, long groupId = null ) : bool
title	string	Новое название для альбома. строка, обязательный параметр (Строка, обязательный параметр).
albumId	long	Идентификатор альбома. положительное число, обязательный параметр (Положительное число, обязательный параметр).
groupId	long	Идентификатор сообщества, которому принадлежит альбом. положительное число (Положительное число).
Résultat	bool

Get() public méthode

Возвращает список аудиозаписей пользователя или сообщества.

Страница документации ВКонтакте .

public Get ( User &user, AudioGetParams @params ) : ReadOnlyCollection
user	User	Данные о пользователе.
@params	AudioGetParams
Résultat	ReadOnlyCollection

GetAlbums() public méthode

Возвращает список альбомов аудиозаписей пользователя или группы.

Страница документации ВКонтакте .

public GetAlbums ( long ownerId, uint count = null, uint offset = null ) : VkCollection
ownerId	long	Идентификатор пользователя или сообщества, у которого необходимо получить список альбомов с аудио. целое число, по умолчанию идентификатор текущего пользователя (Целое число, по умолчанию идентификатор текущего пользователя).
count	uint	Количество альбомов, которое необходимо вернуть. положительное число, по умолчанию 50, максимальное значение 100 (Положительное число, по умолчанию 50, максимальное значение 100).
offset	uint	Смещение, необходимое для выборки определенного подмножества альбомов. положительное число (Положительное число).
Résultat	VkCollection

GetBroadcastList() public méthode

Возвращает список друзей и сообществ пользователя, которые транслируют музыку в статус.

Страница документации ВКонтакте .

public GetBroadcastList ( string filter = null, bool active = null ) : UserOrGroup
filter	string	Определяет, какие типы объектов необходимо получить. Возможны следующие значения параметра: /// /// friends — только друзья; /// groups — только сообщества; /// all — друзья и сообщества. строка, по умолчанию all (Строка, по умолчанию all).
active	bool	1 — будут возвращены только друзья и сообщества, которые транслируют музыку в данный момент. По умолчанию возвращаются все. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
Résultat	UserOrGroup

GetBroadcastListFriends() public méthode

Возвращает список друзей, которые транслируют музыку в статус.

Страница документации ВКонтакте .

public GetBroadcastListFriends ( bool active = false ) : ReadOnlyCollection
active	bool	true — будут возвращены только друзья и сообщества, которые транслируют музыку в данный момент. По умолчанию возвращаются все.
Résultat	ReadOnlyCollection

GetBroadcastListGroup() public méthode

Возвращает список сообществ пользователя, которые транслируют музыку в статус.

Страница документации ВКонтакте .

public GetBroadcastListGroup ( bool active = false ) : ReadOnlyCollection
active	bool	true — будут возвращены только друзья и сообщества, которые транслируют музыку в данный момент. По умолчанию возвращаются все.
Résultat	ReadOnlyCollection

GetById() public méthode

Возвращает информацию об аудиозаписях.

Страница документации ВКонтакте .

public GetById ( ) : ReadOnlyCollection
Résultat	ReadOnlyCollection

GetById() public méthode

Возвращает информацию об аудиозаписях.

Страница документации ВКонтакте .

public GetById ( IEnumerable audios ) : ReadOnlyCollection
audios	IEnumerable	Идентификаторы аудиозаписей, информацию о которых необходимо вернуть, в виде {owner_id}_{audio_id}. список строк, разделенных через запятую, обязательный параметр (Список строк, разделенных через запятую, обязательный параметр).
Résultat	ReadOnlyCollection

GetCount() public méthode

Возвращает количество аудиозаписей пользователя или сообщества.

Страница документации ВКонтакте .

public GetCount ( long ownerId ) : long
ownerId	long	Идентификатор владельца аудиозаписей (пользователь или сообщество). Обратите внимание, идентификатор сообщества в параметре owner_id необходимо указывать со знаком "-" — например, owner_id=-1 соответствует идентификатору сообщества ВКонтакте API (club1) целое число, обязательный параметр (Целое число, обязательный параметр).
Résultat	long

GetLyrics() public méthode

Возвращает текст аудиозаписи.

Страница документации ВКонтакте .

public GetLyrics ( long lyricsId ) : Lyrics
lyricsId	long	Идентификатор текста аудиозаписи, информацию о котором необходимо вернуть. целое число, обязательный параметр (Целое число, обязательный параметр).
Résultat	Lyrics

GetPopular() public méthode

Возвращает список аудиозаписей из раздела "Популярное".

Страница документации ВКонтакте .

public GetPopular ( bool onlyEng = false, AudioGenre genre = null, uint count = null, uint offset = null ) : ReadOnlyCollection
onlyEng	bool	1 – возвращать только зарубежные аудиозаписи. 0 – возвращать все аудиозаписи. (по умолчанию) флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
genre	AudioGenre	Идентификатор жанра из списка жанров. положительное число (Положительное число).
count	uint	Количество возвращаемых аудиозаписей. положительное число, максимальное значение 1000, по умолчанию 100 (Положительное число, максимальное значение 1000, по умолчанию 100).
offset	uint	Смещение, необходимое для выборки определенного подмножества аудиозаписей. положительное число (Положительное число).
Résultat	ReadOnlyCollection

GetRecommendations() public méthode

Возвращает список рекомендуемых аудиозаписей на основе списка воспроизведения заданного пользователя или на основе одной выбранной аудиозаписи.

Страница документации ВКонтакте .

public GetRecommendations ( long userId = null, uint count = null, uint offset = null, bool shuffle = true, string targetAudio = "" ) : ReadOnlyCollection
userId	long	Идентификатор пользователя для получения списка рекомендаций на основе его набора аудиозаписей (по умолчанию — идентификатор текущего пользователя). положительное число (Положительное число).
count	uint	Количество возвращаемых аудиозаписей. положительное число, максимальное значение 1000, по умолчанию 100 (Положительное число, максимальное значение 1000, по умолчанию 100).
offset	uint	Смещение относительно первой найденной аудиозаписи для выборки определенного подмножества. положительное число (Положительное число).
shuffle	bool	1 — включен случайный порядок. флаг, может принимать значения 1 или 0 (Флаг, может принимать значения 1 или 0).
targetAudio	string	Идентификатор аудиозаписи, на основе которой будет строиться список рекомендаций. Используется вместо параметра uid. Идентификатор представляет из себя разделённые знаком подчеркивания id пользователя, которому принадлежит аудиозапись, и id самой аудиозаписи. Если аудиозапись принадлежит сообществу, то в качестве первого параметра используется -id сообщества. строка (Строка).
Résultat	ReadOnlyCollection

GetUploadServer() public méthode

Возвращает адрес сервера для загрузки аудиозаписей.

Страница документации ВКонтакте .

public GetUploadServer ( ) : Uri
Résultat	System.Uri

MoveToAlbum() public méthode

Перемещает аудиозаписи в альбом.

Страница документации ВКонтакте .

public MoveToAlbum ( long albumId, IEnumerable audioIds, long groupId = null ) : bool
albumId	long	Идентификатор альбома, в который нужно переместить аудиозаписи. положительное число (Положительное число).
audioIds	IEnumerable	Идентификаторы аудиозаписей, которые требуется переместить. список положительных чисел, разделенных запятыми, обязательный параметр (Список положительных чисел, разделенных запятыми, обязательный параметр).
groupId	long	Идентификатор сообщества, в котором размещены аудиозаписи. Если параметр не указан, работа ведется с аудиозаписями текущего пользователя. положительное число (Положительное число).
Résultat	bool

Reorder() public méthode

Изменяет порядок аудиозаписи, перенося ее между аудиозаписями, идентификаторы которых переданы параметрами after и before.

Страница документации ВКонтакте .

public Reorder ( long audioId, long ownerId, long before, long after ) : bool
audioId	long	Идентификатор аудиозаписи, которую нужно переместить. положительное число, обязательный параметр (Положительное число, обязательный параметр).
ownerId	long	Идентификатор владельца аудиозаписи (пользователь или сообщество). По умолчанию — идентификатор текущего пользователя. целое число, по умолчанию идентификатор текущего пользователя (Целое число, по умолчанию идентификатор текущего пользователя).
before	long	Идентификатор аудиозаписи, перед которой нужно поместить композицию aid. целое число (Целое число).
after	long	Идентификатор аудиозаписи, после которой нужно поместить композицию aid. целое число (Целое число).
Résultat	bool

Restore() public méthode

Восстанавливает аудиозапись после удаления.

Страница документации ВКонтакте .

public Restore ( long audioId, long ownerId = null ) : Model.Audio
audioId	long	Идентификатор аудиозаписи. положительное число, обязательный параметр (Положительное число, обязательный параметр).
ownerId	long	Идентификатор владельца аудиозаписи (пользователь или сообщество). По умолчанию — идентификатор текущего пользователя. целое число, по умолчанию идентификатор текущего пользователя (Целое число, по умолчанию идентификатор текущего пользователя).
Résultat	Model.Audio

Save() public méthode

Сохраняет аудиозаписи после успешной загрузки.

Страница документации ВКонтакте .

public Save ( string response, string artist = null, string title = null ) : Model.Audio
response	string	Параметр, возвращаемый в результате загрузки аудиофайла на сервер.
artist	string	Автор композиции. По умолчанию берется из ID3 тегов.
title	string	Название композиции. По умолчанию берется из ID3 тегов.
Résultat	Model.Audio

Search() public méthode

Возвращает список аудиозаписей в соответствии с заданным критерием поиска.

Для вызова этого метода Ваше приложение должно иметь права с битовой маской, содержащей Settings.Audio. Страница документации ВКонтакте .

Query is null or empty.;query

public Search ( AudioSearchParams @params ) : VkCollection
@params	AudioSearchParams
Résultat	VkCollection

SetBroadcast() public méthode

Транслирует аудиозапись в статус пользователю или сообществу.

Страница документации ВКонтакте .

public SetBroadcast ( string audio, IEnumerable targetIds ) : ReadOnlyCollection
audio	string	Идентификатор аудиозаписи, которая будет отображаться в статусе, в формате owner_id_audio_id. Например, 1_190442705. Если параметр не указан, аудиостатус указанных сообществ и пользователя будет удален. строка (Строка).
targetIds	IEnumerable	Перечисленные через запятую идентификаторы сообществ и пользователя, которым будет транслироваться аудиозапись. Идентификаторы сообществ должны быть заданы в формате "-gid", где gid - идентификатор сообщества. Например, 1,-34384434. По умолчанию аудиозапись транслируется текущему пользователю. список целых чисел, разделенных запятыми, количество элементов должно составлять не более 20 (Список целых чисел, разделенных запятыми, количество элементов должно составлять не более 20).
Résultat	ReadOnlyCollection