На главную

Метод Audio.Search

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

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

Синтаксис

public ReadOnlyCollection<Audio> Search(AudioSearchParams @params, out long totalCount)

Параметры

Класс AudioSearchParams содержит следующие свойства:

• Q - Текст поискового запроса, например, The Beatles. строка
• AutoComplete - Если этот параметр равен 1, возможные ошибки в поисковом запросе будут исправлены. Например, при поисковом запросе Иуфедуы поиск будет осуществляться по строке Beatles. флаг, может принимать значения 1 или 0
• Lyrics - Если этот параметр равен 1, поиск будет производиться только по тем аудиозаписям, которые содержат тексты. флаг, может принимать значения 1 или 0
• PerformerOnly - Если этот параметр равен 1, поиск будет осуществляться только по названию исполнителя. флаг, может принимать значения 1 или 0
• Sort - Вид сортировки. 2 — по популярности, 1 — по длительности аудиозаписи, 0 — по дате добавления. целое число
• SearchOwn - 1 – искать по аудиозаписям пользователя, 0 – не искать по аудиозаписям пользователя (по умолчанию). флаг, может принимать значения 1 или 0
• Offset - Смещение, необходимое для выборки определенного подмножетсва аудиозаписей. По умолчанию — 0. положительное число
• Count - Количество аудиозаписей, информацию о которых необходимо вернуть. Обратите внимание — даже при использовании параметра offset для получения информации доступны только первые 1000 результатов. положительное число, по умолчанию 30, максимальное значение 300

Результат

После успешного выполнения возвращает список объектов audio. Обратите внимание, что ссылки на mp3 привязаны к ip-адресу.

Исключения

• AccessTokenInvalidException - не задан или используется неверный AccessToken.
• InvalidParamException - строка поискового запроса пуста или равна значению null.

Пример

// Ищем аудиозаписи про The Beatles.
int totalCount;
var audios = vk.Audio.Search("Beatles", out totalCount);

// Ищем аудиозаписи про The Beatles, но ошибаясь и выбирая только три записи начиная с пятой, сортированных по длительности.
int totalCount;
var audios = vk.Audio.Search("иуфедуы", out totalCount, true, AudioSort.Duration, true, 3, 5);

Версия Вконтакте API v.5.44

Дата обновления: 26.01.2016 19:20:10