Skip to content

Commit

Permalink
Merge pull request #373 from edx/ahodges/DOC-2039
Browse files Browse the repository at this point in the history
Adding transcript menu events released in February
  • Loading branch information
Alison Hodges committed Jun 8, 2015
2 parents c0ed256 + 461f92b commit bdf4752
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
5 changes: 4 additions & 1 deletion en_us/data/source/front_matter/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ April-June 2015

* - Date
- Change
* - 8 Jun 2015
- Added descriptions of the ``video_show_cc_menu`` and
``video_hide_cc_menu`` events to the :ref:`Tracking Logs` section.
* - 19 May 15
- Added information about new instructor report events to the
:ref:`Tracking Logs` chapter.
:ref:`Tracking Logs` section.
* - 11 May 2015
- Updated the descriptions of the ``pause_video``, ``play_video``, and
``stop_video`` :ref:`video interaction events<video>` to include the
Expand Down
40 changes: 40 additions & 0 deletions en_us/data/source/internal_data_formats/tracking_logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,8 @@ the ``name`` field only for events that have an ``event_source`` of 'mobile'.
* ``show_transcript``/``edx.video.transcript.shown``
* ``speed_change_video``
* ``stop_video``/``edx.video.stopped``
* ``video_hide_cc_menu``
* ``video_show_cc_menu``

A browser or the edX mobile app emits video interaction events when a user
interacts with a video.
Expand Down Expand Up @@ -1286,6 +1288,44 @@ this type as for the :ref:`play_video` events.
* ``currentTime``: The time in the video at which play stopped, in seconds.
* ``id``

``video_hide_cc_menu``
************************************************

When a user selects a language from the **CC** menu for a video that
has transcripts in multiple languages, the browser emits a
``video_hide_cc_menu`` event.

**Event Source**: Browser

**History**: Added 17 Feb 2015.

``event`` **Member Fields**:

The ``video_hide_cc_menu`` events include the following ``event`` member
fields. These fields serve the same purpose for events of this type as for
:ref:`play_video`.

* ``code``
* ``id``

``video_show_cc_menu``
************************************************

When a user selects **CC** for a video that has transcripts in multiple
languages, the browser emits a ``video_show_cc_menu`` event. This event is
emitted in addition to the ``show_transcript`` event.

**Event Source**: Browser

``event`` **Member Fields**:

The ``video_show_cc_menu`` events include the following ``event`` member
fields. These fields serve the same purpose for events of this type as for
:ref:`play_video`.

* ``code``
* ``id``

.. _pdf:

=================================
Expand Down

0 comments on commit bdf4752

Please sign in to comment.