The constructor prepares the BTimeCode object for use. If you use the first form of the constructor, without arguments, you'll have to call an appropriate function to set the BTimeCode's time information before using it for translation purposes. This can be done by calling one or more of SetData(), SetType(), SetMicroseconds(), or SetLinearFrames().

The second form of the constructor accepts as input a time in microseconds, us, and the timecode type.

The third form accepts as input a time in hours, minutes, seconds, and frames, as well as the timecode type.

The fourth form of the constructor duplicates an existing BTimeCode object.

A typical destructor

GetData() returns the timecode's value in hours, minutes, seconds, and frames, and also returns the timecode type, if you specify a valid pointer for outType. SetData() lets you set the timecode's value.

Fills str, which must be at least 24 bytes long, with a string indicating the current time in hours, minutes, seconds, and frames. The string is formatted in a manner appropriate to the timecode type. A typical example would be "01:24:09.18", which is 1 hour, 24 minutes, 9 seconds, and 18 frames.

These functions return the time's hours, minutes, seconds, and frames portions.

LinearFrames() returns the BTimeCode object's time in linear frames. SetLinearFrames() lets you change the time, specifying the new time in linear frames.

Microseconds() returns the BTimeCode object's time, in microseconds. SetMicroseconds() lets you change the time, specifying the new time in microseconds.

Type() returns the BTimeCode object's timecode type. SetType() lets you change the timecode type.

Makes the current BTimeCode identical to the BTimeCode object specified

Determines whether or not the two BTimeCode objects are equal (their times are the same, regardless of their timecode types).

Indicates whether or not one BTimeCode's time, in microseconds, is less than the other's.

Adds the time of the BTimeCode object other to the current BTimeCode's time.

Subtracts the time of the BTimeCode object other from the current BTimeCode's time.

Adds two BTimeCode values together, returning a new BTimeCode.

Subtracts two BTimeCode values, returning a new one.

Returns the number of recognized time code types.

frames_to_timecode() converts the frame offset linearFrames into hours, minutes, seconds, and frames.

timecode_to_frames() converts the time from hours, minutes, seconds, and frames into a linear frame offset, storing the result in linearFrames.

The timecode_info structure code is used to determine how the conversion should be made, if you specify it. Otherwise B_TIMECODE_DEFAULT is assumed.

Currently these functions always return B_OK, but you should still check for errors because you'd hate it if your app broke in the future, wouldn't you?

Fills out the timecode_info structure specified by outTimeCode with information describing the specified timecode type.

us_to_timecode() converts the time micros, which is specified in microseconds, into hours, minutes, seconds, and frames.

timecode_to_us() converts the time from hours, minutes, seconds, and frames into microseconds, storing the result in micros.

The timecode_info structure code is used to determine how the conversion should be made, if you specify it. Otherwise B_TIMECODE_DEFAULT is assumed.

Currently these functions always return B_OK, but you should still check for errors because you'd hate it if your app broke in the future, wouldn't you?

Declared in: media/TimeCode.h

Constants identifying the various timecode types supported by BTimeCode.

Declared in: media/TimeCode.h

struct timecode_info {
    timecode_type type;
    int drop_frames;
    int every_nth;
    int except_nth;
    int fps_div;
    char name[32];
    char format[32];
    char _reserved_[64];
};

The timecode_info structure describes the attributes of a timecode type. You probably should just use the BTimeCode class, or the global C functions, though. It just makes your life easier.