Audio.GetOggTags

(число) Аудио канал, чьи теги Ogg Vorbis нужны:

КОНСТАНТА CONSTANT	ЗНАЧЕНИЕ VALUE	ОПИСАНИЕ DESCRIPTION
CHANNEL_BACKGROUND	5	Фоновый аудио канал.
CHANNEL_EFFECTS	0	Канал эффектов (используется для звуков мышки - наезд на объект, сход с объекта и клик).
CHANNEL_NARRATION	6	Дикторский канал (используется для наложения голоса).
CHANNEL_USER1	1	1 пользовательский канал.
CHANNEL_USER2	2	2 пользовательский канал.
CHANNEL_USER3	3	3 пользовательский канал.
CHANNEL_USER4	4	4 пользовательский канал.

(таблица) Таблица, содержащая Ogg теги, индексированная по следующим категориям:

КЛЮЧ KEY	ТИП TYPE	ОПИСАНИЕ DESCRIPTION
TITLE	строка	Заголовок Ogg трека (из Ogg тега). Если информация не найдена, будет возвращена пустая строка.
VERSION	строка	Версия трека (например, данные ремикса). Если информация не найдена, будет возвращена пустая строка.
ALBUM	строка	Имя альбома (из Ogg тега). Если информация не найдена, будет возвращена пустая строка.
TRACKNUMBER	число	Альбомный трек для текущей песни (из Ogg тега).
ARTIST	строка	Артист трека. Если информация не найдена, будет возвращена пустая строка.
PERFORMER	строка	Исполнитель трека (зачастую тоже самое, что и артист). Если информация не найдена, будет возвращена пустая строка.
COPYRIGHT	строка	Сведения об авторских правах (например, "2001 Nobody's Band"). Если информация не найдена, будет возвращена пустая строка.
LICENSE	строка	Лицензионные данные (например,"All Rights Reserved"). Если информация не найдена, будет возвращена пустая строка.
ORGANIZATION	строка	Имя организации выпустившей трек. Если информация не найдена, будет возвращена пустая строка.
DESCRIPTION	строка	Краткое описание содержимого. Если информация не найдена, будет возвращена пустая строка.
GENRE	строка	Краткий текст, указывающий музыкальный жанр. Если информация не найдена, будет возвращена пустая строка.
DATE	строка	Дата записи трека. Если информация не найдена, будет возвращена пустая строка.
LOCATION	строка	Расположение, где трек был записан. Если информация не найдена, будет возвращена пустая строка.
CONTACT	строка	Контактная информация о создателях и дистрибьютерах трека. Если информация не найдена, будет возвращена пустая строка.
ISRC	строка	ISRC (International Standard Recording Code) число трека. Для более подробной информации по ISRC, зайдите на http://www.ifpi.org/site-content/online/isrc_intro.html. Если информация не найдена, будет возвращена пустая строка. Примечание переводчика: International Standard Recording Code - международный стандартный код записи (определенный в стандарте DIN-31-621). Указанная выше ссылка дает ошибку - страница не найдена, вот ссылка на Википедию по-русски http://ru.wikipedia.org/wiki/ISRC, а вот на английском, на сайте, что предлагается в справке http://www.ifpi.org/content/section_resources/isrc.html.
RAWTAGS	строка	Список всех тегов, разделенных запятой, в поле комментариев. (Причина этого то, что в комментариях уже может быть что-либо.) Это будет выглядеть примерно так: "TITLE=Roxy,ENGINEER=Jack Coolguy,BUBBLEBOY=No One Is Here". Здесь нельзя вставлять стандартные теги It does not have to contain the standard tags на теги, что действительно были в поле комментариев. that were actually in the Comment field.

Если происходит ошибка, возвращается значение nil. Можно использовать Application.GetLastError для определения случился ли отказ в работе этого действия и почему.

При добавлении действия из редактора скрипта, можно использовать это поле для определения переменной, которая возвращает значение, сохраняющееся в ней.

tOggInfo = Audio.GetOggTags(CHANNEL_USER1);
Title = tOggInfo.TITLE;

Получаем данные Ogg тега из файла Ogg, загруженного в настоящее время в канал CHANNEL_USER1 и сохраняем их в таблице, названной "tOggInfo". Затем из таблицы берется заголовок трека и сохраняется в переменой "Title".

-- Load an Ogg Vorbis audio file into a channel
-- Загружаем Ogg Vorbis аудио файл в канал
Audio.Load(CHANNEL_NARRATION, "AutoPlay\\Audio\\ShortSong.ogg", false, false);

-- Make sure the Load action was successful
-- Убеждаемся, что действие загрузки завершилось успешно
if (Application.GetLastError() == 0) then

    -- Check for file description tags
    -- Проверка тегов описания файла
    tags = Audio.GetOggTags(CHANNEL_NARRATION);
    if (tags ~= nil) then
        albumtitle = tags.TITLE;
        artist = tags.ARTIST;
        album = tags.ALBUM;
    end

    -- Tell the channel to start playing the audio track
    -- Запускаем воспроизведение аудио трека в канале
    Audio.Play(CHANNEL_NARRATION);
end

В этом примере вначале загружается Ogg Vorbis аудио файл в канал звукового сопровождения (дикторский канал). После загрузки, теги описания считываются при помощи действия Audio.GetOggTags и сохраняются в таблице, называемой "tags". Затем три из этих тегов берутся из таблицы и сохраняются в переменных.