Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.
Prev Previous commit
Next Next commit
[[ Player ]] Update dictionary entries for player properties
This patch updates the dictionary entries for the "enabedTracks",
"trackCount", "tracks", and "loadedTime" properties to show that the
support for these properties has changed on Windows due to the switch
to MediaFoundation.

In addition, references to QuickTime have been removed as these are
now obsolete.
  • Loading branch information
Ian Macphail committed May 15, 2020
commit 0f3ea9d1f388e3f7a87bf6036119b50a831d0906
13 changes: 7 additions & 6 deletions docs/dictionary/property/enabledTracks.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Type: property
Syntax: set the enabledTracks of <player> to <tracksList>

Summary:
Specifies which tracks in a <QuickTime> movie are available to be
Specifies which tracks in a movie are available to be
played.

Associations: player

Introduced: 1.0

OS: mac, linux
OS: mac, windows, linux

Platforms: desktop, server

Expand All @@ -25,18 +25,19 @@ track ID (a positive <integer>).

Description:
Use the <enabledTracks> <property> to control the user's ability to play
a <QuickTime> movie.
a movie.

A movie can contain multiple tracks intended to be played at the same
time (for example, an audio and a video track), or tracks that are
separate (for example, an alternative audio track). You can list the
tracks in a movie using the tracks <property>.

Changes:
This property was removed from the Windows platform in version 8.1.0,
due to the change of player implementation from QuickTime to DirectShow.
This property was added to the Windows platform in version 9.7.0, due
to the change of player implementation from DirectShow to
MediaFoundation.

References: QuickTime (glossary), property (glossary), integer (keyword),
References: property (glossary), integer (keyword),
trackCount (property)

Tags: multimedia
Expand Down
6 changes: 4 additions & 2 deletions docs/dictionary/property/loadedTime.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Associations: player

Introduced: 6.7

OS: mac, windows
OS: mac

Platforms: desktop

Expand All @@ -27,7 +27,9 @@ Use the <loadedTime> <property> to find out up to which time a movie or
sound can be played.

Changes:
Support for this property on Windows was added in version 8.1.0.
Support for this property on Windows was removed in version 9.7.0 due
to the change of player implementation from DirectShow to
MediaFoundation.

References: property (glossary), player (keyword), looping (property),
endTime (property), showSelection (property), callbacks (property),
Expand Down
15 changes: 8 additions & 7 deletions docs/dictionary/property/trackCount.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Type: property
Syntax: get the trackCount of <player>

Summary:
Specifies the number of separate tracks in a <QuickTime> movie.
Specifies the number of separate tracks in a movie.

Associations: player

Introduced: 1.0

OS: mac, linux
OS: mac, windows, linux

Platforms: desktop, server

Expand All @@ -27,17 +27,18 @@ This property is read-only and cannot be set.

Description:
Use the <trackCount> <property> to loop through the tracks in a
<QuickTime> movie.
movie.

Each track of a QuickTime movie holds a different set of data, which may
Each track of a movie holds a different set of data, which may
consist of sound, video, or other data types. The <trackCount>
<property> specifies how many tracks there are.

Changes:
This property was removed from the Windows platform in version 8.1.0,
due to the change of player implementation from QuickTime to DirectShow.
This property was added to the Windows platform in version 9.7.0, due
to the change of player implementation from DirectShow to
MediaFoundation.

References: QuickTime (glossary), property (glossary), integer (keyword),
References: property (glossary), integer (keyword),
enabledTracks (property), tracks (property), mediaTypes (property),
nodes (property)

Expand Down
27 changes: 18 additions & 9 deletions docs/dictionary/property/tracks.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Type: property
Syntax: get the tracks of <player>

Summary:
Lists all the tracks in a <QuickTime> movie.
Lists all the tracks in a movie.

Associations: player

Introduced: 1.0

OS: mac, linux
OS: mac, windows, linux

Platforms: desktop, server

Expand All @@ -22,25 +22,34 @@ Value (enum):
The <tracks> is a list of tracks, one per <line>. Each <line> consists
of four <items>, separated by commas:
- the track ID (an integer)
- the track media type (for example, "audio", "video", or
"VR Panorama" )
- the track media type (a string)

This property is read-only and cannot be set

Description:
Use the <tracks> <property> to find out the contents of a <QuickTime>
movie.
Use the <tracks> <property> to find out the contents of a movie.

A movie can contain multiple tracks intended to be played at the same
time (for example, an audio and a video track), or tracks that are
separate (for example, an alternative audio track). You specify which
tracks are active using the enabledTracks <property>.

**Track media types**
The track media type may be one of the following values:
- "vide": Video data
- "soun": Audio data
- "muxx": Combined video & audio data stream
- "meta": File metadata (MacOS X only)
- "sbtl": Subtitle data
- "tmcd": Timecode data (MacOS X only)
- "clcp": Closed caption data (MacOS X only)

Changes:
This property was removed from the Windows platform in version 8.1.0,
due to the change of player implementation from QuickTime to DirectShow.
This property was added to the Windows platform in version 9.7.0, due
to the change of player implementation from DirectShow to
MediaFoundation.

References: QuickTime (glossary), property (glossary), items (keyword),
References: property (glossary), items (keyword),
line (keyword), duration (property), trackCount (property)

Tags: multimedia
Expand Down