Главная / Action Script 3
Пакетfl.video
Классpublic class FLVPlaybackCaptioning
НаследованиеFLVPlaybackCaptioning Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

Компонент FLVPlaybackCaptioning позволяет использовать подписи в компоненте FLVPlayback. ПРИМЕЧАНИЕ. Эта документация предназначена для использования с FLVPlaybackCaptioning с компонентом специальных возможностей.

В ней содержится обновленное описание языка и компонентов ActionScript 3.0 для класса FLVPlaybackCaptioning для включения следующих свойств и методов, которые были добавлены для усовершенствования использования клавиатуры и средства для чтения с экрана для компонента.

Перед попыткой доступа к новым свойствам или методам убедитесь, что в проект добавлена версия компонента со специальными возможностями.

Компонент FLVPlaybackCaptioning загружает XML-файл в формате Timed Text (TT) и использует эти субтитры к компоненту FLVPlayback, для которого данный компонент является родительским.

Дополнительные сведения о формате Timed Text см. по адресу http://www.w3.org/AudioVideo/TT/. Компонент FLVPlaybackCaptioning поддерживает подмножество спецификации Timed Text 1.0. Подробную информацию о поддерживаемых подмножествах см. в разделе "Метки формата Timed Text". Ниже приведен краткий пример.

  <?xml version="1.0" encoding="UTF-8"?>
  <tt xml:lang="en" xmlns="http://www.w3.org/2006/04/ttaf1"  xmlns:tts="http://www.w3.org/2006/04/ttaf1#styling">
      <head>
          <styling>
              <style id="1" tts:textAlign="right"/>
              <style id="2" tts:color="transparent"/>
              <style id="3" style="2" tts:backgroundColor="white"/>
              <style id="4" style="2 3" tts:fontSize="20"/>
          </styling>
      </head>
      <body>
           <div xml:lang="en">
              <p begin="00:00:00.50" dur="500ms">Four score and twenty years ago</p>
              <p begin="00:00:02.50"><span tts:fontFamily="monospaceSansSerif,proportionalSerif,TheOther"tts:fontSize="+2">our forefathers</span> brought forth<br /> on this continent</p>
              <p begin="00:00:04.40" dur="10s" style="1">a <span tts:fontSize="12 px">new</span> <span tts:fontSize="300%">nation</span></p>
              <p begin="00:00:06.50" dur="3">conceived in <span tts:fontWeight="bold" tts:color="#ccc333">liberty</span> <span tts:color="#ccc333">and dedicated to</span> the proposition</p>
              <p begin="00:00:11.50" tts:textAlign="right">that <span tts:fontStyle="italic">all</span> men are created equal.</p>
     <p begin="15s" style="4">The end.</p>
          </div>    
      </body>
  </tt>
  

Посмотреть примеры



Общедоступные свойства
 СвойствоОпределено
 InheritedaccessibilityProperties : AccessibilityProperties
Текущие параметры специальных возможностей для данного экранного объекта.
DisplayObject
 Inheritedalpha : Number
Указывает значение альфа-прозрачности заданного объекта.
DisplayObject
  autoLayout : Boolean
Определяет, должен ли компонент FLVPlaybackCaptioning автоматически перемещать и изменять размеры объектов TextField, используемых в качестве подписей.
FLVPlaybackCaptioning
 InheritedblendMode : String
Значение класса BlendMode, задающее режим наложения.
DisplayObject
 InheritedblendShader : Shader
[только для записи] Задает затенение, используемое при наложении переднего плана на фон.
DisplayObject
 InheritedbuttonMode : Boolean
Задает режим кнопки данного спрайта.
Sprite
 InheritedcacheAsBitmap : Boolean
При значении true проигрыватель Flash Player кэширует внутреннее растровое представление экранного объекта.
DisplayObject
  captionButton : Sprite
Определяет пользовательский экземпляр компонента графического интерфейса captionButton FLVPlayback, которые предоставляет возможность включения и отключения подписей.
FLVPlaybackCaptioning
  captionTarget : DisplayObject
Задает экземпляр объекта DisplayObject для отображения подписей.
FLVPlaybackCaptioning
  captionTargetName : String
Имя экземпляра объекта TextField или объекта MovieClip, включающего объект Textfield, который содержит подписи.
FLVPlaybackCaptioning
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcontextMenu : ContextMenu
Определяет контекстное меню, связанное с данным объектом.
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
Определяет, получает ли объект события doubleClick.
InteractiveObject
 InheriteddropTarget : DisplayObject
[только для чтения] Определяет экранный объект, над которым перетаскивается спрайт, либо на котором спрайт был отпущен.
Sprite
 Inheritedfilters : Array
Индексированный массив, который содержит все объекты filter, связанные в настоящий момент с экранным объектом.
DisplayObject
  flvPlayback : FLVPlayback
Задает экземпляр FLVPlayback для работы с подписями.
FLVPlaybackCaptioning
  flvPlaybackName : String
Задает имя экземпляра FLVPlayback для экземпляра FLVPlayback, в котором нужно включить подписи.
FLVPlaybackCaptioning
 InheritedfocusRect : Object
Задает отображение прямоугольной рамки индикатора фокуса для данного объекта.
InteractiveObject
 Inheritedgraphics : Graphics
[только для чтения] Задает объект Graphics, принадлежащий данному спрайту, в котором могут выполняться команды векторного рисования.
Sprite
 Inheritedheight : Number
Указывает высоту экранного объекта в пикселах.
DisplayObject
 InheritedhitArea : Sprite
Определяет другой спрайт в качестве области щелчка для спрайта.
Sprite
 InheritedloaderInfo : LoaderInfo
[только для чтения] Возвращает объект LoaderInfo, содержащий сведения о загрузке файла, к которому принадлежит этот экранный объект.
DisplayObject
 Inheritedmask : DisplayObject
Вызывающий экранный объект маскируется заданным объектом mask.
DisplayObject
 InheritedmouseChildren : Boolean
Определяет, включен ли переход между потомками объекта с помощью мыши.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Определяет, получает ли этот объект сообщения мыши.
InteractiveObject
 InheritedmouseX : Number
[только для чтения] Указывает координату x положения курсора мыши (в пикселах).
DisplayObject
 InheritedmouseY : Number
[только для чтения] Указывает координату y положения курсора мыши (в пикселах).
DisplayObject
 Inheritedname : String
Указывает имя экземпляра DisplayObject.
DisplayObject
 InheritednumChildren : int
[только для чтения] Возвращает число потомков данного объекта.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Определяет, является ли экранный объект непрозрачным с определенным цветом фона.
DisplayObject
 Inheritedparent : DisplayObjectContainer
[только для чтения] Указывает объект DisplayObjectContainer, содержащий данный экранный объект.
DisplayObject
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
 Inheritedroot : DisplayObject
[только для чтения] В случае с экранным объектом в загруженном SWF-файле свойством root является самый верхний экранный объект в части структуры дерева списка отображения, представленной этим SWF-файлом.
DisplayObject
 Inheritedrotation : Number
Указывает поворот экземпляра DisplayObject относительно его исходной ориентации (в градусах).
DisplayObject
 InheritedrotationX : Number
Обозначает поворот в градусах по оси x экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 InheritedrotationY : Number
Обозначает поворот в градусах по оси у экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 InheritedrotationZ : Number
Обозначает поворот в градусах по оси z экземпляра DisplayObject относительно исходной ориентации по трехмерному родительскому контейнеру.
DisplayObject
 Inheritedscale9Grid : Rectangle
Текущая активная сетка масштабирования.
DisplayObject
 InheritedscaleX : Number
Указывает горизонтальное масштабирование объекта от точки регистрации (в процентах).
DisplayObject
 InheritedscaleY : Number
Указывает вертикальное масштабирование объекта от точки регистрации (в процентах).
DisplayObject
 InheritedscaleZ : Number
Указывает масштабирование глубины объекта (в процентах) относительно точки регистрации этого объекта.
DisplayObject
 InheritedscrollRect : Rectangle
Прямоугольная область прокрутки экранного объекта.
DisplayObject
  showCaptions : Boolean
Используется для отображения подписей; true = подписи отображаются, false = подписи не отображаются.
FLVPlaybackCaptioning
  simpleFormatting : Boolean
Ограничивает инструкции форматирования из файла Timed Text, если установлено значение true.
FLVPlaybackCaptioning
 InheritedsoundTransform : SoundTransform
Управляет звуком в данном спрайте.
Sprite
  source : String
URL-адрес XML-файла формата Timed Text, который содержит информацию о подписях (обязательное свойство).
FLVPlaybackCaptioning
 Inheritedstage : Stage
[только для чтения] Класс Stage экранного объекта.
DisplayObject
 InheritedtabChildren : Boolean
Определяет, включен ли переход между потомками объекта с помощью клавиши Tab.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Определяет, включен ли этот объект в последовательность перехода с помощью клавиши Tab.
InteractiveObject
 InheritedtabIndex : int
Задает последовательность перехода между объектами в SWF-файле.
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
[только для чтения] Возвращает объект TextSnapshot для данного экземпляра DisplayObjectContainer.
DisplayObjectContainer
  track : uint
Поддержка дорожек для нескольких языков.
FLVPlaybackCaptioning
 Inheritedtransform : Transform
Объект со свойствами, относящимися к матрице, преобразованию цвета и пиксельным границам экранного объекта.
DisplayObject
 InheriteduseHandCursor : Boolean
Логическое значение, определяющее, должен ли отображаться указатель "рука" при наведении указателя мыши на спрайт, в котором свойство buttonMode имеет значение true.
Sprite
  videoPlayerIndex : uint
Подключает систему подписей к указанному объекту VideoPlayer в компоненте FLVPlayback.
FLVPlaybackCaptioning
 Inheritedvisible : Boolean
Определяет видимость экранного объекта.
DisplayObject
 Inheritedwidth : Number
Указывает ширину экранного объекта в пикселах.
DisplayObject
 Inheritedx : Number
Указывает координату x экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer.
DisplayObject
 Inheritedy : Number
Указывает координату y экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer.
DisplayObject
 Inheritedz : Number
Указывает положение по оси z экземпляра DisplayObject относительно трехмерного родительского контейнера.
DisplayObject
Общедоступные методы
 МетодОпределено
  
Создает новый экземпляр FLVPlaybackCaptioning.
FLVPlaybackCaptioning
 Inherited
Добавляет дочерний экземпляр DisplayObject к данному экземпляру DisplayObjectContainer.
DisplayObjectContainer
 Inherited
Добавляет дочерний экземпляр DisplayObject к данному экземпляру DisplayObjectContainer.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события в объекте EventDispatcher, в результате чего прослушиватель будет получать уведомления о событиях.
EventDispatcher
 Inherited
Показывает, могут ли ограничения безопасности привести к пропуску каких-либо экранных объектов в списке, возвращаемом в результате вызова метода DisplayObjectContainer.getObjectsUnderPoint() с заданной точкой.
DisplayObjectContainer
 Inherited
Определяет, является ли заданный экранный объект дочерним объектом экземпляра DisplayObjectContainer или самим экземпляром.
DisplayObjectContainer
 Inherited
Передает событие в поток событий.
EventDispatcher
  
Возвращает массив свойств cuePoints компонентов FLVPlayback, в тексте заголовков которых содержится строка поиска.
FLVPlaybackCaptioning
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Возвращает прямоугольник, определяющий область экранного объекта, которая относится к системе координат объекта targetCoordinateSpace.
DisplayObject
  
Возвращает массив свойств cuePoints компонентов FLVPlayback, в которых содержатся заголовки.
FLVPlaybackCaptioning
  
getCaptionsAsTranscript(preserveFormatting:Boolean = false):String
Возвращает строку, содержащую все заголовки, в виде записи в формате HTML.
FLVPlaybackCaptioning
 Inherited
Возвращает экземпляр дочернего экранного объекта, существующий в заданной позиции индекса.
DisplayObjectContainer
 Inherited
Возвращает экземпляр дочернего экранного объекта с заданным именем.
DisplayObjectContainer
 Inherited
Возвращает позицию индекса для дочернего экземпляра DisplayObject.
DisplayObjectContainer
 Inherited
Возвращает массив объектов, расположенных ниже заданной позиции и являющихся дочерними объектами любого уровня для данного экземпляра DisplayObjectContainer.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Возвращает прямоугольник, определяющий границу экранного объекта по системе координат, заданной параметром targetCoordinateSpace, за исключением линий фигур.
DisplayObject
 Inherited
Преобразует объект Point из координат рабочей области (глобальных) в координаты экранного объекта (локальные).
DisplayObject
 Inherited
Преобразует двумерный объект Point из координат рабочей области (глобальных) в координаты экранного трехмерного объекта (локальные).
DisplayObject
 Inherited
Проверяет наличие у объекта EventDispatcher прослушивателей событий, которые зарегистрированы для получения уведомлений о событиях определенного типа.
EventDispatcher
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Оценивает экранный объект, чтобы определить, перекрывает ли он экранный объект obj или пересекается с ним.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Вычисляет экранный объект, чтобы определить, перекрывает ли он точку, заданную координатами x и y, или пересекает ее.
DisplayObject
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Преобразует трехмерный объект point из координат трехмерного экранного объекта (локальных) в двухмерный объект point с координатами рабочей области (глобальными).
DisplayObject
 Inherited
Преобразует объект point из координат экранного объекта (локальных) в координаты рабочей области (глобальные).
DisplayObject
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Удаляет заданный дочерний объект DisplayObject из списка потомков экземпляра DisplayObjectContainer.
DisplayObjectContainer
 Inherited
Удаляет дочерний DisplayObject из заданной позиции индекса в списке потомков DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель из объекта EventDispatcher.
EventDispatcher
  
Возвращает количество секунд в виде строки временного кода.
FLVPlaybackCaptioning
 Inherited
Изменяет положение существующего потомка в DisplayObjectContainer.
DisplayObjectContainer
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Позволяет пользователю перетаскивать заданный спрайт (растровый графический объект, легко перемещаемый по экрану).
Sprite
 Inherited
Завершает метод startDrag().
Sprite
 Inherited
Меняет местами (в порядке "от начала к концу") два заданных дочерних объекта.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Меняет местами (в порядке "от начала к концу") дочерние объекты, расположенные в двух заданных позициях индекса в списке потомков.
DisplayObjectContainer
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
 Inherited
Проверяет, зарегистрирован ли прослушиватель событий в объекте EventDispatcher или в любом из его предков для получения уведомлений о событиях определенного типа.
EventDispatcher
События
 Событие Сводка Определено
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player перемещается в фокус операционной системы и становится активным.EventDispatcher
 InheritedОтправляется, когда экранный объект добавляется в список отображения.DisplayObject
 InheritedОтправляется, когда экранный объект добавляется к списку отображения в рабочей области, либо непосредственно, либо путем добавления поддерева, содержащего экранный объект.DisplayObject
  Отправляется при добавлении или удалении подписи из целевого текстового поля.FLVPlaybackCaptioning
  Отправляется после создания свойства captionTarget, но до добавления каких-либо подписей (свойство captionTarget пусто).FLVPlaybackCaptioning
 InheritedОтправляется, когда пользователь выбирает команду "Удалить" в контекстном меню текста.InteractiveObject
 InheritedОтправляется, когда пользователь нажимает и отпускает главную кнопку на указывающем устройстве над одним и тем же объектом InteractiveObject.InteractiveObject
  Отправляется после загрузки всех XML-данных в формате Timed Text.FLVPlaybackCaptioning
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Копировать", или выбирает команду "Копировать" из контекстного меню.InteractiveObject
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Вырезать", или выбирает команду "Вырезать" из контекстного меню.InteractiveObject
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player покидает фокус операционной системы и становится неактивным.EventDispatcher
 InheritedОтправляется, когда пользователь дважды нажимает и отпускает главную кнопку на указывающем устройстве над одним и тем же объектом InteractiveObject, а флаг doubleClickEnabled для этого объекта имеет значение true.InteractiveObject
 Inherited[многоадресное событие] Отправляется, когда точка воспроизведения переходит в новый кадр.DisplayObject
 Inherited[многоадресное событие] Отправляется, когда точка воспроизведения покидает текущий кадр.DisplayObject
 InheritedОтправляется, когда экранный объект перемещается в фокус.InteractiveObject
 InheritedОтправляется, когда экранный объект покидает фокус.InteractiveObject
 Inherited[многоадресное событие] Отправляется после завершения работы конструкторов экранных объектов кадра до выполнения сценариев кадра.DisplayObject
  Отправляется при попытке доступа к XML-файлу с данными в формате Timed Text по протоколу HTTP путем вызова метода URLLoader.load(), если при этом текущая среда Flash Player способна определить и вернуть код состояния для запроса.FLVPlaybackCaptioning
  Отправляется, если в результате вызова метода URLLoader.load() возникает неустранимая ошибка, которая приводит к завершению загрузки XML-файла с данными в формате Timed Text.FLVPlaybackCaptioning
 InheritedОтправляется, когда пользователь нажимает клавишу.InteractiveObject
 InheritedОтправляется, когда пользователь пытается изменить фокус с помощью клавиатуры.InteractiveObject
 InheritedОтправляется, когда пользователь отпускает клавишу.InteractiveObject
 InheritedОтправляется, когда пользователь нажимает кнопку на указывающем устройстве над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь пытается изменить фокус с помощью указывающего устройства.InteractiveObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство в момент, когда курсор находится над объектом InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство от экземпляра InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь наводит указывающее устройству на экземпляр InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь отпускает кнопку на указывающем устройстве над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
 InheritedОтправляется, когда пользователь вращает колесико мыши над экземпляром InteractiveObject в окне проигрывателя Flash Player.InteractiveObject
  Отправляется, когда в результате вызова метода URLLoader.load() начинается операция по загрузке XML-файла с данными в формате Timed Text.FLVPlaybackCaptioning
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Вставить", или выбирает команду "Вставить" из контекстного меню.InteractiveObject
  Отправляется по мере получения данных в ходе загрузки XML-файла с данными в формате Timed Text.FLVPlaybackCaptioning
 InheritedОтправляется перед удалением экранного объекта из списка отображения.DisplayObject
 InheritedОтправляется перед удалением экранного объекта из списка отображения, либо непосредственно, либо путем удаления поддерева, содержащего экранный объект.DisplayObject
 Inherited[многоадресное событие] Отправляется перед обновлением и визуализацией списка отображения.DisplayObject
 InheritedОтправляется, когда пользователь перемещает указывающее устройство от экземпляра InteractiveObject.InteractiveObject
 InheritedОтправляется, когда пользователь наводит указывающее устройство на экземпляр InteractiveObject.InteractiveObject
  Отправляется при попытке загрузить путем вызова метода URLLoader.load() XML-файл с данными в формате Timed Text с сервера, расположенного за пределами изолированной среды.FLVPlaybackCaptioning
 InheritedОтправляется, когда пользователь активирует комбинацию клавиш ускорения, используемую на данной платформе для операции "Выделить все", или выбирает команду "Выделить все" из контекстного меню.InteractiveObject
 InheritedОтправляется, когда изменяется значение свойства tabChildren объекта.InteractiveObject
 InheritedОтправляется при изменении флага tabEnabled объекта.InteractiveObject
 InheritedОтправляется, когда изменяется значение свойства tabIndex объекта.InteractiveObject
Общедоступные константы
 Константа Определено
  SHORT_VERSION : String = "2.0"
[статические] Переменная состояния, указывающая сокращенный номер версии компонента.
FLVPlaybackCaptioning
  VERSION : String = "2.0.0.38"
[статические] Переменная состояния, указывающая полный номер версии компонента.
FLVPlaybackCaptioning
Сведения о свойстве
autoLayoutсвойство
autoLayout:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

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

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



Реализация
    public function get autoLayout():Boolean
    public function set autoLayout(value:Boolean):void

См. также

captionButtonсвойство 
captionButton:Sprite  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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



Реализация
    public function get captionButton():Sprite
    public function set captionButton(value:Sprite):void

См. также

captionTargetсвойство 
captionTarget:DisplayObject  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

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

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

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



Реализация
    public function get captionTarget():DisplayObject
    public function set captionTarget(value:DisplayObject):void

См. также

captionTargetNameсвойство 
captionTargetName:String  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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



Реализация
    public function get captionTargetName():String
    public function set captionTargetName(value:String):void

См. также

flvPlaybackсвойство 
flvPlayback:FLVPlayback  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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



Реализация
    public function get flvPlayback():FLVPlayback
    public function set flvPlayback(value:FLVPlayback):void

См. также

flvPlaybackNameсвойство 
flvPlaybackName:String  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

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

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



Реализация
    public function get flvPlaybackName():String
    public function set flvPlaybackName(value:String):void

См. также

showCaptionsсвойство 
showCaptions:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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



Реализация
    public function get showCaptions():Boolean
    public function set showCaptions(value:Boolean):void

См. также

simpleFormattingсвойство 
simpleFormatting:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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



Реализация
    public function get simpleFormatting():Boolean
    public function set simpleFormatting(value:Boolean):void
sourceсвойство 
source:String  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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



Реализация
    public function get source():String
    public function set source(value:String):void
trackсвойство 
track:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

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

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

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



Реализация
    public function get track():uint
    public function set track(value:uint):void
videoPlayerIndexсвойство 
videoPlayerIndex:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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



Реализация
    public function get videoPlayerIndex():uint
    public function set videoPlayerIndex(value:uint):void

См. также

Сведения о конструкторе
FLVPlaybackCaptioning()Конструктор
public function FLVPlaybackCaptioning()

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

Сведения о методе
findInCaptions()метод
public function findInCaptions(searchString:String):Array

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

Возвращает массив свойств cuePoints компонентов FLVPlayback, в тексте заголовков которых содержится строка поиска.

Параметры

searchString:String — Искомая строка в тексте заголовков.

Возвращает
Array — Array Массив свойств cuePoints компонентов FLVPlayback
getCaptionsAsArray()метод 
public function getCaptionsAsArray():Array

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

Возвращает массив свойств cuePoints компонентов FLVPlayback, в которых содержатся заголовки.

Возвращает
Array — Array Массив свойств cuePoints компонентов FLVPlayback
getCaptionsAsTranscript()метод 
public function getCaptionsAsTranscript(preserveFormatting:Boolean = false):String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

Возвращает строку, содержащую все заголовки, в виде записи в формате HTML.

Каждый заголовок содержится в теге p с атрибутом class fl_video_caption, атрибутом уникального идентификатора id, начинающегося со строки fl_video_caption_2_0, и атрибутом title, обозначающим временной код, согласно которому заголовок отображается в видеозаписи.

Ниже приводится краткий пример возвращаемого кода HTML:

   <div id="fl_video_transcript" class="fl_video_transcript">
    <p class="fl_video_caption" id="fl_video_caption_2_0_1" title="0:00.50"><i>( speaking French ): </i><br/><b>George: </b> Bonjour, Marie.</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_2" title="0:01.75"><b>Marie: </b> Bonjour, George.</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_3" title="0:03.75">Voilà une sucette.</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_4" title="0:05.50"><b>George: </b> C'est pour moi?</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_5" title="0:06.50"><b>Marie: </b> Oui, c'est pour toi.</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_6" title="0:08.00"><b>George: </b> Merci, Marie!</p>
    <p class="fl_video_caption" id="fl_video_caption_2_0_7" title="0:09.50"><b>Marie: </b> De rien, George.</p>
   </div>
   

Параметры

preserveFormatting:Boolean (default = false) — Сохраняет теги HTML, используемые для форматирования текста заголовков в приложении Flash

Возвращает
String — String Строка, содержащая все заголовки, в виде записи в формате HTML
secondsToTime()метод 
public function secondsToTime(sec:Number):String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

Возвращает количество секунд в виде строки временного кода.

Параметры

sec:Number — Количество секунд.

Возвращает
String
Сведения о событии
captionChange Событие
Тип объекта события: fl.video.CaptionChangeEvent
свойство CaptionChangeEvent.type = fl.video.CaptionChangeEvent.CAPTION_CHANGE

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

Задает значение свойства type для объекта события captionChange.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
addedЛогическое значение, показывающее, была ли надпись добавлена или удалена с экрана.
captionCuePointObjectОбъект ключевой точки для данной подписи.

См. также

captionTargetCreated Событие  
Тип объекта события: fl.video.CaptionTargetEvent
свойство CaptionTargetEvent.type = fl.video.CaptionTargetEvent.CAPTION_TARGET_CREATED

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

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

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

Константа CaptionTargetEvent.CAPTION_TARGET_CREATED определяет значение свойства type объекта события captionTargetCreated.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
captionTargetОтображает объект из свойства captionTarget экземпляра FLVPlaybackCaptioning.

См. также

complete Событие  
Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.COMPLETE

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

Константа Event.COMPLETE определяет значение свойства type объекта complete.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, который завершил загрузку.

См. также

httpStatus Событие  
Тип объекта события: flash.events.HTTPStatusEvent
свойство HTTPStatusEvent.type = flash.events.HTTPStatusEvent.HTTP_STATUS

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

Константа HTTPStatusEvent.HTTP_STATUS определяет значение свойства type объекта события httpStatus.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
statusКод состояния HTTP, возвращенный сервером.
targetСетевой объект, получающий код состояния НТТР.

См. также

ioError Событие  
Тип объекта события: flash.events.IOErrorEvent
свойство IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

Задает значение свойства type для объекта события ioError.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, с которым произошла ошибка ввода/вывода.
textТекст, отображаемый в качестве сообщения об ошибке.

См. также

open Событие  
Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.OPEN

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

Константа Event.OPEN определяет значение свойства type объекта события open.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, установивший подключение.

См. также

progress Событие  
Тип объекта события: flash.events.ProgressEvent
свойство ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

Задает значение свойства type для объекта события progress.

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

СвойствоЗначение
bubblesfalse
bytesLoadedЧисло элементов или байт, загруженных на момент обработки события прослушивателем.
bytesTotalОбщее число элементов или байт, которые в итоге будут получены в случае успешного завершения загрузки.
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, сообщающий сведения о прогрессе.

См. также

securityError Событие  
Тип объекта события: flash.events.SecurityErrorEvent
свойство SecurityErrorEvent.type = flash.events.SecurityErrorEvent.SECURITY_ERROR

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

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

Константа SecurityErrorEvent.SECURITY_ERROR определяет значение свойства type для объекта события securityError.

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

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, сообщающий об ошибке безопасности.
textТекст, отображаемый в качестве сообщения об ошибке.

См. также

Сведения о константе
SHORT_VERSIONКонстанта
public static const SHORT_VERSION:String = "2.0"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

trace (FLVPlaybackCaptioning.SHORT_VERSION);

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

См. также

VERSIONКонстанта  
public static const VERSION:String = "2.0.0.38"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.0.28.0

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

trace (FLVPlaybackCaptioning.VERSION);

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

См. также

Примеры Как пользоваться примерами
FLVPlaybackCaptioningExample.as

В данном примере показан динамический способ создания экземпляра FLVPlayback с переключаемым выводом субтитров.

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

  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;            
        }
    }
}