Определяет, должен ли компонент FLVPlaybackCaptioning автоматически перемещать и изменять размеры объектов TextField, используемых в качестве подписей.

Если для свойства autoLayout установлено значение true, то экземпляр DisplayObject или объект TextField, содержащий надписи, отображается на высоте 10 пикселей от нижней границы экземпляра FLVPlayback. Область субтитров занимает ширину экземпляра FLVPlayback, сохраняя отступ от каждой стороны по 10 пикселей.

Если для данного свойства установлено значение true, то экземпляр DisplayObject или TextField отображается непосредственно над экземпляром FLVPlayback. Если создается собственный объект TextField, то необходимо для свойства autoLayout установить значение false. Если свойство wordWrap имеет значение false, то область субтитров устанавливается по центру над экземпляром FLVPlayback, но она может быть шире экземпляра FLVPlayback.

Для управления расположением необходимо прослушивать событие captionChange для того, чтобы обнаружить создание экземпляра объекта TextField.

Значение по умолчанию true

См. также

Определяет пользовательский экземпляр компонента графического интерфейса captionButton FLVPlayback, которые предоставляет возможность включения и отключения подписей.

Функции свойтва captionButton сходны с свойствами объекта FLVPlayback: playButton, pauseButton, muteButton и т. д.

См. также

Задает экземпляр объекта DisplayObject для отображения подписей.

При установке экземпляра как объекта TextField он устанавливается непосредственно к целевому экземпляру. Если экземпляр устанавливается как объект DisplayObjectContainer, содержащий один и более объектов TextField, то подписи отображаются в объекте TextField с минимальным индексом отображения.

Метод DisplayObjectContainer поддерживает фрагмент ролика как объект с фоном "масштаб-9", который может масштабироваться при изменении размера объекта TextField.

Для более полного масштабирования и прорисовки напишите код для прослушивания методом DisplayObjectContainer события captionChange.

Примечание. Если свойство captionTargetName или свойствоcaptionTarget не установлено, то экземпляр FLVPlaybackCaptioning создает текстовое поле с заданным свойством captionTarget в следующем формате:

• черный фон (background = true; backgroundColor = 0x000000;)
• белый текст (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Для настройки данных параметров прослушивайте событие captionTargetCreated.

См. также

Имя экземпляра объекта TextField или объекта MovieClip, включающего объект Textfield, который содержит подписи.

Если требуется не задавать цель, установите для данного свойства пустую строку (означает, что нет определенной цели) или значение auto. Данное свойство первоначально используется в инспекторе компонентов. При программировании вместо этого используйте свойство captionTarget.

Значение по умолчанию auto

См. также

Задает экземпляр FLVPlayback для работы с подписями. Экземпляр FLVPlayback должен иметь такой же родительский объект, что и экземпляр FLVPlaybackCaptioning.

Если свойство flvPlaybackName или flvPlayback не установлено, то экземпляр FLVPlaybackCaptioning ищет экземпляр FLVPlayback с тем же родительским объектом и выводит подпись в первом найденном экземпляре.

См. также

Задает имя экземпляра FLVPlayback для экземпляра FLVPlayback, в котором нужно включить подписи.

Если требуется не задавать цель, установите пустую строку или значение auto. Экземпляр FLVPlayback должен иметь такой же родительский объект, что и экземпляр FLVPlaybackCaptioning.

Имя экземпляра FLVPlayback первоначально используется в инспекторе компонента. При программировании используйте свойство flvPlayback.

Если свойство flvPlaybackName или flvPlayback не установлено или для свойства установлено значение auto, то экземпляр FLVPlaybackCaptioning ищет экземпляр FLVPlayback с тем же родительским объектом и выводит подсказки в первом найденном экземпляре.

Значение по умолчанию auto

См. также

Используется для отображения подписей: если значение свойства — true, то подписи отображаются, если значение свойства — false, то подписи не отображаются.

При использовании свойства captionButton, позволяющего включать и выключать субтитры, установите свойство showCaptions в значение false.

Значение по умолчанию true

См. также

Ограничивает инструкции форматирования из файла Timed Text, если установлено значение true.

Если для свойства simpleFormatting установлено значение true, то следующие стили не поддерживаются.

• tts:backgroundColor
• tts:color
• tts:fontSize
• tts:fontFamily
• tts:wrapOption

Если для свойства simpleFormatting установлено значение true, то поддерживаются следующие стили:

• tts:fontStyle
• tts:fontWeight
• tts:textAlign

URL-адрес XML-файла формата Timed Text, который содержит информацию о подписях (обязательное свойство).

Поддержка дорожек для нескольких языков.

Наилучшим использованием свойства track является поддержка нескольких языковых дорожек с встроенными ключевыми точками.

Необходимо соблюдать поддерживаемые форматы ключевых точек объекта FLVPlaybackCaptioning.

Если для свойства track установлено значение, отличное от 0, то компонент FLVPlaybackCaptioning ищет в ключевой точке свойство text<n>, где n — значение дорожки.

Например, если track == 1, то компонент FLVPlayBackCaptioning ищет в ключевой точке параметр text1. Если совпадающего параметра не найдено, то используется свойство text в параметре ключевой точки.

Значение по умолчанию 0

Подключает систему подписей к указанному объекту VideoPlayer в компоненте FLVPlayback.

Для использования надписей в нескольких видеопроигрывателях (со свойствами activeVideoPlayerIndex и visibleVideoPlayerIndex компонента FLVPlayback) необходимо создать один экземпляр компонента FLVPlaybackCaptioning для каждого используемого экземпляра VideoPlayer и установить в данном свойстве соответствующий индекс.

Если используется один видеопроигрыватель, то индекс по умолчанию равен 0.

См. также

Создает новый экземпляр FLVPlaybackCaptioning.

Отправляется при добавлении или удалении подписи из целевого текстового поля.

Данное событие также отправляется при выполнении следующих условий:

• не установлено свойство captionTargetName
• не установлено свойство captionTarget
• экземпляр FLVPlaybackCaptioning автоматически создает объект TextField для вывода субтитров.

Событие captionChange имеет константу CaptionChangeEvent.CAPTION_CHANGE.

Данное событие имеет следующие свойства.

См. также

Событие отправляется после создания свойства captionTarget, но до добавления каких-либо подписей (свойство captionTarget пусто).

Если свойство captionTarget установлено пользовательским объектом DisplayObject или установлено свойство captionTargetName, то данное событие не обрабатывается.

Прослушивайте данное событие при настройке свойств объекта TextField, например свойства defaultTextFormat.

Событие captionTargetCreated имеет константу CaptionTargetEvent.CAPTION_TARGET_CREATED.

Данное событие имеет следующие свойства.

См. также

Отправляется после загрузки всех XML-данных в формате Timed Text.

Данное событие имеет следующие свойства.

См. также

Событие отправляется при попытке доступа к XML-файлу с данными в формате Timed Text по протоколу HTTP путем вызова метода URLLoader.load(), если при этом текущая среда Flash Player способна определить и вернуть код состояния для запроса.

Данное событие имеет следующие свойства.

См. также

Событие отправляется, если в результате вызова метода URLLoader.load() возникает неустранимая ошибка, которая прерывает загрузку XML-файла с данными в формате Timed Text.

Если данное событие не обрабатывается, это приведет к появлению ошибки.

Данное событие имеет следующие свойства.

См. также

Событие отправляется, когда в результате вызова метода URLLoader.load() начинается загрузка XML-файла с данными в формате Timed Text.

Данное событие имеет следующие свойства.

См. также

Отправляется по мере получения данных в ходе загрузки XML-файла с данными в формате Timed Text.

Данное событие имеет следующие свойства.

См. также

Событие отправляется при попытке с помощью вызова метода URLLoader.load() загрузить XML-файл с данными в формате Timed Text с сервера, расположенного за пределами изолированной среды.

Если данное событие не обрабатывается, это приведет к появлению ошибки.

Данное событие имеет следующие свойства.

См. также

Переменная состояния, указывающая сокращенный номер версии компонента. Номер версии полезен, если есть FLA-файл и нужно узнать версию компонента. Для определения версии компонента вставьте следующий код в FLA-файл.

trace (FLVPlaybackCaptioning.SHORT_VERSION);

Переменная SHORT_VERSION включает только старший и младший номер версии, например 2.0. Переменная version включает старший и младший номер версии, редакцию и номер сборки, например 2.0.0.xx.

См. также

Переменная состояния, указывающая полный номер версии компонента. Номер версии полезен, если есть FLA-файл и нужно узнать версию компонента. Для определения версии компонента вставьте следующий код в FLA-файл.

trace (FLVPlaybackCaptioning.VERSION);

Переменная VERSION включает старший и младший номер версии, редакцию и номер сборки, например 2.0.0.xx. Переменная SHORT_VERSION включает только старший и младший номер версии, например 2.0.

См. также

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

1. Откройте новый файл Flash (ActionScript 3.0).
2. Поместите компонент FLVPlayback в рабочую область в положение 0,0 и задайте экземпляру имя player.
3. Поместите компонент FLVPlaybackCaptioning в рабочую область в положение 0,0 и задайте экземпляру имя captioning.
4. Поместите на рабочий стол компонент CaptionButton.
5. Сохраните FLA-файл и присвойте ему имя, например captionEx.
6. Откройте новый файл ActionScript.
7. Вставьте следующий образец кода класса в новый файл ActionScript и сохраните его как FLVPlaybackCaptioningExample.as в тот же каталог, где находится FLA-файл.
8. В FLA-файле (например, captionEx), используя Инспектор свойств, установите запись класса Document на FLVPlaybackCaptioningExample.
9. Выберите "Управление" > "Тестировать ролик".

package
{
    import fl.video.CaptionChangeEvent;
    import fl.video.FLVPlayback;
    import fl.video.FLVPlaybackCaptioning;
    import flash.display.Sprite;
    import flash.text.TextField;
    
    public class FLVPlaybackCaptioningExample extends Sprite {

        private var videoPath:String = "http://www.helpexamples.com/flash/video/caption_video.flv";
        private var captioningPath:String = "http://www.helpexamples.com/flash/video/caption_video.xml";
        
        public function FLVPlaybackCaptioningExample() {
            player.source = videoPath;
            player.skin = "SkinOverAllNoCaption.swf";
            player.skinBackgroundColor = 0x666666;
            player.skinBackgroundAlpha = 0.5;

            captioning.flvPlayback = player;
            captioning.source = captioningPath;
            captioning.autoLayout = false;            
            captioning.addEventListener(CaptionChangeEvent.CAPTION_CHANGE, onCaptionChange);
        }

        private function onCaptionChange(e:CaptionChangeEvent):void {
            var tf:* = e.target.captionTarget;
            var player:FLVPlayback = e.target.flvPlayback;

            // move the caption below the video
            tf.y = 210;            
        }
    }
}