blob: 53220ca85dccb768d428a1efc7c7a1a22a592da4 [file] [log] [blame]
.TH "MP4" "3" "Version 0.9" "Cisco Systems Inc." "MP4 File Format Library"
.SH "NAME"
.LP
\fBMP4WriteRtpHint\fR \- Write an RTP hint
.SH "SYNTAX"
.LP
#include <mp4.h>
.LP
bool \fBMP4WriteRtpHint\fR(
.br
MP4FileHandle \fIhFile\fP,
.br
MP4TrackId \fItrackId\fP,
.br
MP4Duration \fIduration\fP,
.br
bool \fIisSyncSample\fP = true
.br
);
.SH "ARGUMENTS"
.LP
.TP
\fIhFile\fP
Specifies the mp4 file to which the operation applies.
.TP
\fItrackId\fP
Specifies the hint track to which the operation applies.
.TP
\fIduration\fP
The duration for this hint sample. Typically this is the same duration as for the corresponding sample in the reference media track. Caveat: The duration should be in the hint track timescale units, again typically the same as the reference media track.
.TP
\fIisSyncSample\fP
The sync/random access flag for this sample. Typically this is the same as for the corresponding sample in the reference media track.
.SH "RETURN VALUES"
.LP
Upon success, true (1). Upon an error, false (0).
.SH "DESCRIPTION"
.LP
\fBMP4WriteRtpHint\fR writes the current pending hint created with MP4AddRtpHint() to the specified hint track.
.SH "SEE ALSO"
.LP
MP4(3) MP4AddRtpHint (3)