<trclass="memdesc:ae2fe9e8d9b67e25f103a78a25417149f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Poll a frame indefinetily from the media stream object. <ahref="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f">More...</a><br/></td></tr>
<trclass="memdesc:a441263e19be4383223884fde8838f736"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Poll a frame for a specified time from the media stream object. <ahref="classuvgrtp_1_1media__stream.html#a441263e19be4383223884fde8838f736">More...</a><br/></td></tr>
<trclass="memdesc:a74a558b23866976e52c5903996544a27"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Asynchronous way of getting frames. <ahref="classuvgrtp_1_1media__stream.html#a74a558b23866976e52c5903996544a27">More...</a><br/></td></tr>
<trclass="memdesc:addf1cde9cb8c4e4af3160ce24c4288a5"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Configure the media stream, see <aclass="el"href="util_8hh.html#aa98d9238629e33567e73af0d239e587f"title="RTP context configuration flags.">RTP_CTX_CONFIGURATION_FLAGS</a> for more details. <ahref="classuvgrtp_1_1media__stream.html#addf1cde9cb8c4e4af3160ce24c4288a5">More...</a><br/></td></tr>
<trclass="memdesc:a1134ff0271ad54bf1e07feed422118c2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Get pointer to the RTCP object of the media stream. <ahref="classuvgrtp_1_1media__stream.html#a1134ff0271ad54bf1e07feed422118c2">More...</a><br/></td></tr>
<p>Configure the media stream, see <aclass="el"href="util_8hh.html#aa98d9238629e33567e73af0d239e587f"title="RTP context configuration flags.">RTP_CTX_CONFIGURATION_FLAGS</a> for more details. </p>
<p>Get pointer to the RTCP object of the media stream. </p>
<p>This object is used to control all RTCP-related functionality and RTCP documentation can be found from <aclass="el"href="classuvgrtp_1_1rtcp.html">uvgrtp::rtcp</a></p>
<dlclass="section return"><dt>Returns</dt><dd>Pointer to RTCP object</dd></dl>
<dlclass="retval"><dt>Return values</dt><dd>
<tableclass="retval">
<tr><tdclass="paramname">uvgrtp::rtcp*</td><td>If RTCP has been enabled (RCE_RTCP has been given to <aclass="el"href="classuvgrtp_1_1session.html#a71aad1226214b1b0b1ba60a46c048ab2"title="Create a bidirectional media stream for an RTP session.">uvgrtp::session::create_stream()</a>) </td></tr>
<tr><tdclass="paramname">nullptr</td><td>If RTCP has not been enabled </td></tr>
<p>Receive hook is an alternative to polling frames using <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">uvgrtp::media_stream::pull_frame()</a>. Instead of application asking from uvgRTP if there are any new frames available, uvgRTP will notify the application when a frame has been received</p>
<p>The hook should not be used for media processing as it will block the receiver from reading more frames. Instead, it should only be used as an interface between uvgRTP and the calling application where the frame hand-off happens.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">arg</td><td>Optional argument that is passed to the hook when it is called, can be set to nullptr </td></tr>
<tr><tdclass="paramname">hook</td><td>Function pointer to the receive hook that uvgRTP should call</td></tr>
<p>Poll a frame indefinetily from the media stream object. </p>
<p>When a frame is received, it is put into the frame vector of the receiver Calling application can poll frames by calling <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a>.</p>
<p>NOTE: <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> is a blocking operation and a separate thread should be spawned for it!</p>
<p>You can specify for how long should <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> block by giving "timeout" parameter that denotes how long <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> will wait for an incoming frame in milliseconds</p>
<p>Poll a frame for a specified time from the media stream object. </p>
<p>When a frame is received, it is put into the frame vector of the receiver Calling application can poll frames by calling <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a>.</p>
<p>NOTE: <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> is a blocking operation and a separate thread should be spawned for it!</p>
<p>You can specify for how long should <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> block by giving "timeout" parameter that denotes how long <aclass="el"href="classuvgrtp_1_1media__stream.html#ae2fe9e8d9b67e25f103a78a25417149f"title="Poll a frame indefinetily from the media stream object.">pull_frame()</a> will wait for an incoming frame in milliseconds</p>
<p>Split "data" into 1500 byte chunks and send them to remote</p>
<p>NOTE: If SCD has been enabled, calling this version of <aclass="el"href="classuvgrtp_1_1media__stream.html#ab2b7507d5b2c76bef74c9bceec07ba18">push_frame()</a> requires either that the caller has given a deallocation callback to SCD OR that "flags" contains flags "RTP_COPY"</p>
<p>NOTE: Each <aclass="el"href="classuvgrtp_1_1media__stream.html#ab2b7507d5b2c76bef74c9bceec07ba18">push_frame()</a> sends one discrete frame of data. If the input frame is fragmented, calling application should call <aclass="el"href="classuvgrtp_1_1media__stream.html#ab2b7507d5b2c76bef74c9bceec07ba18">push_frame()</a> with RTP_MORE and RTP_SLICE flags to prevent uvgRTP from flushing the frame queue after <aclass="el"href="classuvgrtp_1_1media__stream.html#ab2b7507d5b2c76bef74c9bceec07ba18">push_frame()</a>.</p>
<p>push_frame(..., RTP_MORE | RTP_SLICE); // more data coming in, do not flush queue push_frame(..., RTP_MORE | RTP_SLICE); // more data coming in, do not flush queue push_frame(..., RTP_SLICE); // no more data coming in, flush queue</p>
<p>If user wishes to manage RTP timestamps himself, he may pass "ts" to <aclass="el"href="classuvgrtp_1_1media__stream.html#ab2b7507d5b2c76bef74c9bceec07ba18">push_frame()</a> which forces uvgRTP to use that timestamp for all RTP packets of "data".</p>
<p>Return RTP_OK success Return RTP_INVALID_VALUE if one of the parameters are invalid Return RTP_MEMORY_ERROR if the data chunk is too large to be processed Return RTP_SEND_ERROR if uvgRTP failed to send the data to remote Return RTP_GENERIC_ERROR for any other error condition </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
