xref: /haiku/docs/develop/media/ParameterWeb.txt (revision 41acdd1d90c2ca793a73a9dee0be1a6e719c7f52)
1*41acdd1dSDario CasalinuovoThis file contains extensions to the standard set of parameter web constants.
2*41acdd1dSDario Casalinuovo
3*41acdd1dSDario Casalinuovo/* constants for extractors */
4*41acdd1dSDario Casalinuovo
5*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_DURATION;
6*41acdd1dSDario Casalinuovo  // Output only: Selects the duration of the stream.
7*41acdd1dSDario Casalinuovo  //
8*41acdd1dSDario Casalinuovo  // This is the playing time of the stream, which may be
9*41acdd1dSDario Casalinuovo  // different from some or all of the durations for the
10*41acdd1dSDario Casalinuovo  // individual streams.  Return a negative number if the
11*41acdd1dSDario Casalinuovo  // duration is not a useful number. (like streaming audio)
12*41acdd1dSDario Casalinuovo  // This duration may be an estimate because determining
13*41acdd1dSDario Casalinuovo  // the exact duration may require parsing an entire file.
14*41acdd1dSDario Casalinuovo  // This duration may also be updated over time.  For
15*41acdd1dSDario Casalinuovo  // example, a file being read may also be being written to
16*41acdd1dSDario Casalinuovo  // by someone else.
17*41acdd1dSDario Casalinuovo
18*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_COPYRIGHT;
19*41acdd1dSDario Casalinuovo  // Output only: Selects the copyright notice of the stream.
20*41acdd1dSDario Casalinuovo  //
21*41acdd1dSDario Casalinuovo  // This is a string with a copyright notice.  The
22*41acdd1dSDario Casalinuovo  // string belongs to the extractor, so don't delete
23*41acdd1dSDario Casalinuovo  // or change it.
24*41acdd1dSDario Casalinuovo
25*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_TRACK_COUNT;
26*41acdd1dSDario Casalinuovo  // Output only: Selects the count of the
27*41acdd1dSDario Casalinuovo  // number of tracks in the stream.
28*41acdd1dSDario Casalinuovo  //
29*41acdd1dSDario Casalinuovo  // This is the current number of tracks in the stream.
30*41acdd1dSDario Casalinuovo
31*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_FRAME_COUNT;
32*41acdd1dSDario Casalinuovo  // Output only: Selects the count of the
33*41acdd1dSDario Casalinuovo  // number of frames in the stream.
34*41acdd1dSDario Casalinuovo  //
35*41acdd1dSDario Casalinuovo  // This is the current number of frames in the stream.
36*41acdd1dSDario Casalinuovo  // See BMediaTrack::CountFrames()
37*41acdd1dSDario Casalinuovo
38*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_CURRENT_FRAME_INDEX;
39*41acdd1dSDario Casalinuovo  // Output only: Selects the index of the
40*41acdd1dSDario Casalinuovo  // current frame in the stream.
41*41acdd1dSDario Casalinuovo  //
42*41acdd1dSDario Casalinuovo  // This is the current frame in the stream.
43*41acdd1dSDario Casalinuovo  // See BMediaTrack::CurrentFrame()
44*41acdd1dSDario Casalinuovo
45*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_CURRENT_TIME;
46*41acdd1dSDario Casalinuovo  // Output only: Selects the current time of the stream.
47*41acdd1dSDario Casalinuovo  //
48*41acdd1dSDario Casalinuovo  // This is the time at the current position of the stream.
49*41acdd1dSDario Casalinuovo  // See BMediaTrack::CurrentTime()
50*41acdd1dSDario Casalinuovo
51*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_ENCODED_FORMAT;
52*41acdd1dSDario Casalinuovo  // Output only: Selects the native encoded format of the streams data.
53*41acdd1dSDario Casalinuovo  //
54*41acdd1dSDario Casalinuovo  // See BMediaTrack::EncodedFormat()
55*41acdd1dSDario Casalinuovo
56*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_TRACK_CODEC_INFO;
57*41acdd1dSDario Casalinuovo  // Output only: Selects the codec information for this stream
58*41acdd1dSDario Casalinuovo  //
59*41acdd1dSDario Casalinuovo  // See BMediaTrack::GetCodecInfo()
60*41acdd1dSDario Casalinuovo
61*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_QUALITY;
62*41acdd1dSDario Casalinuovo  // Input/output: Selects the quality rating for this stream
63*41acdd1dSDario Casalinuovo  //
64*41acdd1dSDario Casalinuovo  // See BMediaTrack::GetQuality and BMediaTrack::SetQuality
65*41acdd1dSDario Casalinuovo
66*41acdd1dSDario Casalinuovo// Used for extractor-based seek:
67*41acdd1dSDario Casalinuovoextern _IMPEXP_MEDIA const char * const B_MEDIA_SEEK_STREAM_NUMBER;
68*41acdd1dSDario Casalinuovo  // Input/Output: Selects the stream to be selected for seeking.
69*41acdd1dSDario Casalinuovo  //
70*41acdd1dSDario Casalinuovo  // When the extractor is asked to seek, it will seek on
71*41acdd1dSDario Casalinuovo  // this stream, and then seek the other streams depending
72*41acdd1dSDario Casalinuovo  // on where it ends up on the first stream.  A typical
73*41acdd1dSDario Casalinuovo  // value for this corresponds to a video stream.  In this
74*41acdd1dSDario Casalinuovo  // case the video stream will be seeked to the closest key
75*41acdd1dSDario Casalinuovo  // frame for example, and then any other streams will be
76*41acdd1dSDario Casalinuovo  // seeked to that time.  Only 'open' streams will be
77*41acdd1dSDario Casalinuovo  // seeked.
78*41acdd1dSDario Casalinuovo
79