JVoIP Video Streaming
<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <div style='border-top:solid #C0504D 6.0pt;border-left:none;border-bottom:solid #C0504D 6.0pt; border-right:none;padding:0in 0in 0in 0in;background:#C0504D'> <p class="MsoTitle">JVoIP –Video Streaming</p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'><br> <br> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <p class="MsoTocHeading">Contents</p> </div> <p class="MsoToc1"><a href="start.htm#_Toc135652662">About<span style='color:windowtext; display:none;text-decoration:none'> </span><span style='color:windowtext;display:none;text-decoration:none'>1</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652663">Usage<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652664">Mode<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc135652665">UDP<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc135652666">API<span style='color:windowtext; display:none;text-decoration:none'> </span><span style='color:windowtext;display:none;text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652667">Parameters<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>3</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652668">API<span style='color:windowtext; display:none;text-decoration:none'> </span><span style='color:windowtext;display:none;text-decoration:none'>3</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652669">Notifications<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>3</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652670">Pseudocode<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>3</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652671">Relay<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>4</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652672">Recording<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>4</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc135652673">FFmpeg<span style='color:windowtext; display:none;text-decoration:none'>. </span><span style='color:windowtext;display:none;text-decoration:none'>4</span></a></p> <p class="MsoNormal"> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652662">About</a></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This document describes the usage of the </span><a href="https://www.mizu-voip.com/Software/SIPSDK/JavaSIPSDK.aspx"><span style='font-size:9.0pt;font-style:normal'>JVoIP</span></a><span style='font-size:9.0pt;font-style:normal'> SIP video streaming features: the capability to send/receive the video stream from other sources. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The main use case is the capability to integrate JVoIP with external video recorder/playback (such as ffmpeg or any video capable app), but otherwise it is up to you how do you handle these streams (video recording, AI processing, routing it to some cloud service, etc).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>In this use-case, JVoIP is mainly responsible for the signaling only (video negotiation) as the actual recording/playback will be done from external software.<br> Your app (from where the video stream is received) must be able to send and/or receive valid standard based </span><a href="https://www.ietf.org/rfc/rfc3550.txt"><span style='font-size:9.0pt; font-style:normal'>RTP</span></a><span style='font-size:9.0pt;font-style:normal'> streams.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This document is only a help for the video streaming use-case. Refer to the JVoIP documentation and the JVoIP video documentation for the other details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This means that the full usage is described in three documents:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-style: normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP documentation</span></a><span style='font-size:9.0pt;font-style:normal'> (<span style='color:#984806'>JVoIP.pdf</span>): describes the JVoIP basic usage (probably you already have this implemented)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>See the "How to send a media stream" and "How to get the media stream" FAQ points for the streaming related details.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP video documentation</span></a><span style='font-size:9.0pt;font-style:normal'> (<span style='color:#984806'>JVoIP_Video.pdf</span>): is an extension for the above JVoIP documentation focusing on the video related functionalities</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-style: normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video_Streaming.pdf"><span style='font-size:9.0pt;font-style:normal'>This document</span></a><span style='font-size:9.0pt;font-style:normal'> (<span style='color:#984806'>JVoIP_Video_Streaming.pdf</span>) : is an extension for the above JVoIP video documentation, focusing only on video streaming (changes and details about this specific use-case)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652663">Usage</a></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>First of all, make sure that simple audio only calls are working correctly using JVoIP with your SIP server (or P2P direct calls to other peers).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Then you might test a video call with the JVoIP built-in video module (with the video_module parameter set to -1 or 2). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Once these are working, you can go ahead to implement video streaming as described in this document.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Adding video streaming support should be simple as shown in the </span><a href="start.htm#_Pseudocode"><span style='font-size:9.0pt;font-style:normal'>pseudocode</span></a><span style='font-size:9.0pt;font-style:normal'> example: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-style: normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Set the related </span><a href="start.htm#_Parameters"><span style='font-size:9.0pt;font-style:normal'>parameters</span></a><span style='font-size:9.0pt;font-style:normal'> for video streaming</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Make/receive a video call using the related </span><a href="start.htm#_API"><span style='font-size: 9.0pt;font-style:normal'>API</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>To initiate a video call, use the <span style='color:#984806'>API_Call</span> funcion with the <span style='color:#984806'>calltype</span> parameter set to <span style='color:#984806'>1</span> and/or use the other video related functions such as <span style='color:#984806'>API_Accept</span> with the <span style='color:#984806'>calltype</span> parameter set to <span style='color:#984806'>1</span> and the <span style='color:#984806'>API_AddVideo</span> / <span style='color:#984806'>API_StopVideo</span> functions.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Watch for the </span><a href="start.htm#_Notifications"><span style='font-size:9.0pt;font-style:normal'>VIDEO notifications</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>You can start/stop sending/receiving based on the call state (<span style='color:#984806'>STATUS</span> notifications) or based on the <span style='color:#984806'>VIDEO</span> notifications.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-style: normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Send/receive the video RTP packets over UDP or by API function calls as described at the </span><a href="start.htm#_Mode"><span style='font-size:9.0pt;font-style:normal'>mode</span></a><span style='font-size:9.0pt;font-style:normal'> chapter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP video documentation</span></a><span style='font-size:9.0pt;font-style:normal'> for the details about the related parameters/functions/notifications. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>We recommend to first test with the very basic settings a simple outgoing video call (API_Call with calltype 1):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>No any quality parameters passed (no video_quality, video_profilelevelid and other quality related parameter passed)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>No SRTP (set the mediaencryption to 0)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Set the video_relay to 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Once the basic video call works, you can test the advanced functionalities one by one:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Set any quality related parameter such as video_quality and/or video_profilelevelid</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Incoming call (API_Accept with calltype 1)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Start with audio-only call and add/remove video later using the API_AddVideo / API_StopVideo functions</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Enable SRTP if you need media encryption (set the mediaencryption to 2)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Test with the above combinations</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>See the “Troubleshooting” chapter in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP video documentation</span></a><span style='font-size:9.0pt;font-style:normal'> if you run into any issue.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652664"></a><a name="_Mode"></a>Mode</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>There are two ways to handle video streaming with JVoIP:<br> <br> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc135652665">UDP</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'><br> In this case your app (or an external app) must send/receive the video stream over RTP/UDP as directed by the VIDEO notifications. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You should use this mode if you are running an application capable to emit or receive standards based RTP/UDP video streams (for example ffmpeg/ffplay).<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Set the following parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_module</span><span style='font-size:9.0pt;font-style:normal'>: <span style='color:#984806'>3</span> (possible values -1: default, 0: disabled, 1: old deprecated applet method, 2: video handling by JVoIP, 3: streaming)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_relay</span><span style='font-size:9.0pt;font-style:normal'>: <span style='color:#984806'>0</span> or <span style='color:#984806'>1</span>:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>0: for video stream directly between your software and the peer, bypassing JVoIP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> 1: if JVoIP have to route the RTP (int this case it will handle all the details, including NAT’s and SRTP if required)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pass the parameters received by the <span style='color:#984806'>VIDEO</span> notification to your app (port number, codec, etc). Your app will have to send/receive video RTP via UDP (like in a usual SIP call; most video ). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc135652666">API</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>In this case your app can send video RTP packets using the API_SendVideoRTP function and it can receive the incoming video packets using the API_GetMedia function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You should use this mode if you wish to send and receive the video RTP packets directly as byte buffers, using API function calls. <br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Set the following parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_module</span><span style='font-size:9.0pt;font-style:normal'>: <span style='color:#984806'>3</span> (possible values -1: default, 0: disabled, 1: old deprecated applet method, 2: video handling by JVoIP, 3: streaming)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_relay</span><span style='font-size:9.0pt;font-style:normal'>: <span style='color:#984806'>1</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_suppresslocalrtp</span><span style='font-size:9.0pt;font-style:normal'>: <span style='color:#984806'>1</span> (so JVoIP will not send the incoming RTP packets also on RTP/UDP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Use the <span style='color:#984806'>API_SendVideoRTP</span> function to send RTP video packets and/or use the <span style='color:#984806'>API_GetMedia</span> function to receive the incoming RTP video packets. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652667"></a><a name="_Parameters"></a>Parameters</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The most important video streaming use-case related parameters are the followings:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Set the <span style='color:#984806'>video_module</span> parameter to <span style='color:#984806'>3</span> (possible values -1: default, 0: disabled, 1: old deprecated applet method, 2: video handling by JVoIP, 3: streaming)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Set the <span style='color:#984806'>video_relay</span> parameters after your needs: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>0 </span><span style='font-size:9.0pt;font-style:normal'>(in UDP mode only to have the video stream directly between your software and the peer, bypassing JVoIP) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>1</span><span style='font-size:9.0pt;font-style:normal'> (JVoIP route the RTP and will handle also all the related task such as NAT handling and SRTP encode/decode when required).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>For “API mode” set also the <span style='color:#984806'>video_suppresslocalrtp</span> parameter to <span style='color:#984806'>1</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Optionally, set the <span style='color:#984806'>video_config</span> parameter for example to 4 (possible values: -1: auto, 2: never enable 4: on request only 6: ask 8: yes 10: always force)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You might specify the video quality with the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:#984806;font-style:normal'>video_quality</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>and/or <span style='color:#984806'>video_profilelevelid</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>and/or <span style='color:#984806'>video_fps</span> / <span style='color:#984806'>video_bitrate</span> / <span style='color:#984806'>video_vwidth</span> / <span style='color:#984806'>video_vheight</span></span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>any other parameters after your needs (general parameters in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP documentation</span></a><span style='font-size:9.0pt;font-style:normal'> and video related parameter described in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>jvoip video documentation</span></a><span style='font-size:9.0pt;font-style:normal'>.)</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652668"></a><a name="_API"></a>API</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Use the <span style='color:#984806'>API_Call</span> funcion with the <span style='color:#984806'>calltype</span> parameter set to <span style='color:#984806'>1</span> to initiate an outgoing video call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Use the <span style='color:#984806'>API_Accept</span> function with the <span style='color:#984806'>calltype</span> parameter set to <span style='color:#984806'>1</span> to accept a video call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You can also initiate audio only calls by the <span style='color:#984806'>API_Call</span> funcion (with the <span style='color:#984806'>calltype</span> parameter set to <span style='color:#984806'>0</span>), and add/remove video later using the <span style='color:#984806'>API_AddVideo</span> / <span style='color:#984806'>API_StopVideo</span> functions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>With the “API” streaming type, use the <span style='color:#984806'>API_SendVideoRTP</span> function to send RTP video packets and/or use the <span style='color:#984806'>API_GetMedia</span> function to receive the incoming RTP video packets. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>More details (describing the above mentioned methods and usage):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP documentation</span></a><span style='font-size:9.0pt;font-style:normal'> (especially the “How to send a media stream” and “How to get the media stream” FAQ points)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP video documentation</span></a></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652669"></a><a name="_Notifications"></a>Notifications</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You will receive a <b><span style='color:#984806'>VIDEO notification</span></b> when recorder/player have to be started/stopped.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;font-style:normal'>Start the recorder</span></b><span style='font-size:9.0pt;font-style:normal'> (your video recorder app such as ffmpeg) when your receive a <span style='color:#984806'>VIDEO,START</span> notification with the <span style='color:#984806'>type</span> parameter set to <span style='color:#984806'>3</span> or<span style='color:#984806'> 4</span>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Make sure to configure your recorder as suggested by the parameters.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;font-style:normal'>Start the player</span></b><span style='font-size:9.0pt;font-style:normal'> (your video player app) when your receive a <span style='color:#984806'>VIDEO,START</span> notification with the <span style='color:#984806'>type</span> parameter set to <span style='color:#984806'>2</span>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>For ffplay, instead of parsing all the parameters, you can just pass the <b><span style='color:#984806'>video_play.sdp</span></b> which will be generated by JVoIP in its work directory which is usually the mwphonedata or you can get the exact path like this: <span style='color:#984806'>String sdppath = wobj.API_GetWorkdir()+"video_play.sdp";</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;font-style:normal'>Stop the recorder</span></b><span style='font-size:9.0pt;font-style:normal'> when your receive a <span style='color:#984806'>VIDEO,STOP</span> notification with the <span style='color:#984806'>type</span> parameter set to <span style='color:#984806'>3</span> or <span style='color:#984806'>4</span>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-size:9.0pt;font-style:normal'>Stop the player</span></b><span style='font-size:9.0pt;font-style:normal'> when your receive a <span style='color:#984806'>VIDEO,STOP</span> notification with the <span style='color:#984806'>type</span> parameter set to <span style='color:#984806'>2</span>.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>You might also start/stop a local video preview when a video call begins/ends (launch it when you receive START,5 and stop it on STOP,6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP_Video.pdf"><span style='font-size:9.0pt;font-style:normal'>JVoIP video documentation</span></a><span style='font-size:9.0pt;font-style:normal'> for the details about this notification.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652670"></a><a name="_Pseudocode"></a>Pseudocode</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#595959;font-style:normal'>...set basic parameters such as serveraddress, username, password, loglevel, mediaencryption, srtp_suite, etc...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_config", 4); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//can be omitted as video is not disabled by default</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_module", 3); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//enable streaming</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_relay", 1); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//let JVoIP handle the video RTP, including SRTP (or set to 0 to bypass)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//</span><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_suppresslocalrtp", 1); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//set this only for “API” streaming type (not for RTP/UDP streaming)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_quality", 12); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//optionally suggest quality</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.SetParameter("video_profilelevelid", "xxx"); </span><span style='font-size:9.0pt;color:#595959;font-style: normal'>// optionally you might preset the H.254 profile-level-id</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#595959;font-style:normal'>...set any other parameters as you wish...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.API_Call(-1,"1234",1); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//initiate video call to 1234</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#31849B;font-style:normal'><- VIDEO,START,3...: start your app recording (start sending RTP/UDP video packets to the peer or use the </span><span style='font-size:9.0pt;color:#984806; font-style:normal'>API_SendVideoRTP</span><span style='font-size:9.0pt; color:#31849B;font-style:normal'> function) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#31849B;font-style:normal'><- VIDEO,START,2...: start your app playback (start receiving RTP/UDP video packets from the peer or use the </span><span style='font-size:9.0pt; color:#984806;font-style:normal'>API_GetMedia</span><span style='font-size: 9.0pt;color:#31849B;font-style:normal'> function)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#595959;font-style:normal'>...video call here...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>wobj.API_Hangup(); </span><span style='font-size:9.0pt;color:#595959;font-style:normal'>//disconnect the call (or it can be disconnected by the peer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#31849B;font-style:normal'><- VIDEO,STOP,3...: stop your app recording (don’t send any more video RTP packets to the peer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#31849B;font-style:normal'><- VIDEO,STOP,2...: stop your app playback (you will not receive any more RTP video packets from the peer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652671">Relay</a></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Use the <span style='color:#984806'>video_relay</span> parameter to specify whether to route or bypass video in “UDP” node:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:#984806;font-style:normal'>0</span><span style='font-size:9.0pt;font-style:normal'>: Send/receive the video RTP stream directly to/from the peer from your app. In this case you are responsible for all the processing (including SRTP encrypt/decrypt if required)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:#984806;font-style:normal'>1</span><span style='font-size:9.0pt;font-style:normal'>: Let JVoIP to route the video and perform the SRTP encrypt/decrypt if required (recommended). In this case your app will send/receive video to/from local JVoIP which then will forward to/from the peer. This is the default value. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>In “API” mode this parameter must be always set to <span style='color:#984806'>1</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>With variant 0 you might run into NAT handling issues if your app is not capable to send/receive from the same port. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>There is little difference between relay 0 and 1 from your app point of view, except that with variant 0 you must handle the SRTP encryption yourself. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The IP and port in the VIDEO notification will be set correctly by JVoIP depending on this video_relay parameter. </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>For variant 0 you will receive the <span style='color:#984806'>peer IP:port</span> for recording (where your app have to send the video RTP) and the <span style='color:#984806'>localip:port</span> to be used for playback (where ffplay have to listen for the incoming RTP)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>For variant 1 you will receive the <span style='color:#984806'>JVoIP IP:port</span> for recording (where your app have to send the video RTP) and the <span style='color:#984806'>127.0.0.1:port</span> to be used for playback (where ffplay have to listen for the incoming RTP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>To enable SRTP negotiations, set the <span style='color:#984806'>mediaencryption</span> parameter to <span style='color:#984806'>2</span>. You can suggest a preferred algorithm with the <span style='color:#984806'>srtp_suite</span> parameter. </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>For variant 0, then you must send the recorded RTP stream with SRTP encryption and decrypt the incoming SRTP stream for playback.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>For variant 1 then SRTP is handled transparently by JVoIP (you will need send/receive unencrypted RTP).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>No SRTP encoding/decoding is required if you don’t receive the SRTP keys with the VIDEO notifications</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652672">Recording</a></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Here the “recording” means saving the video call to file (not media recording from a video device).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The video can be already streamed as described in this document and from there you can process it (save it to file) as you wish. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>A simplified method for video saving will be also added in the upcoming new major release. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="mailto:info@mizu-voip.com?subject=JVoIP%20video%20recording"><span style='font-size:9.0pt;font-style:normal'>Contact us</span></a><span style='font-size:9.0pt;font-style:normal'> if you are interested in this functionality. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc135652673">FFmpeg</a></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>FFmpeg/FFplay related suggestions (in case if you are using this for video recording/playback).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:9.0pt;font-style:normal'>Payload</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Make sure to generate the RTP packets with the same payload number as specified by the payload parameter in the VIDEO notification (FFmpeg -payload_type parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:9.0pt;font-style:normal'>Port</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Ideally for SIP the same port should be used for sending/receiving.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This is useful for NAT traversal and some SIP server expect it the same way and might not be able to handle separate ports correctly.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>You might run into NAT handling difficulties if you set the video_relay parameter to 0 (streaming from/to peer directly from your software) and your external app(s) is incapable to send/receive from the same port.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Regarding SIP server compatibility: hopefully your server will handle this correctly, otherwise you must always use variant 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Regarding NAT handing: we implemented a trick in our software to send a few empty (CRLF) packets from the playback port before emitting the VIDEO,START,2 notification (also will close the UDP socket before the notification so ffplay will be able to listen on the same port). These packets should open the NAT device so you should be able to receive the incoming RTP streams even from external networks. This feature can be controlled with the <span style='color:#984806'>video_relay_opennat</span> parameter (set to 0 to disable, 1 to enable; default is 1).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>In case if somehow you wish to launch the video player before actual playback then you can suggest a port number to be used for playback (where the remote audio will be sent) with the video_port_ffplaylisten parameter. JVoIP will try to use this port, but otherwise you must use the port number received in the VIDEO notification or as stated in the video_play.sdp.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:9.0pt;font-style:normal'>Delay</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>FFmpeg and especially FFplay can introduce a delay for the video streams. You should fine-tune them with the minimal possible buffering. <br> </span><a href="mailto:support@mizu-voip.com?subject=JVoIP%20video%20streaming%20ffmpeg%20optimization"><span style='font-size:9.0pt;font-style:normal'>Contact our support</span></a><span style='font-size:9.0pt;font-style:normal'> for the optimal flags to minimize ffmpeg/ffplay delay.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:9.0pt;font-style:normal'>ffmpeg parameters</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Here is a list of the ffmpeg parameters to be set regarding the received VIDEO notification parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>0.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>VIDEO: header</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>startstop: START</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>type: start ffmpeg if type is 3 or 4</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>reason: not applicable</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>ip: rtp://IP:port</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>port: rtp://ip:PORT</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>codec: -c:v CODEC</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>payload: payload_type PAYLOAD</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>quality: you might calculate other parameters based on this such as bandwidth, fps, profile, etc</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>9.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>bw: -v:b BANDWIDTHk -maxrate BANDWIDTH -bufsize 2*BANDWIDTH</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>10.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>max_bw: : -v:b BANDWIDTHk -maxrate BANDWIDTH -bufsize 2*BANDWIDTH</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>11.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>fps: -framerate VFPS -r VFPS</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>12.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>max_fps: -framerate VFPS -r VFPS</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>13.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>width: –vf scale="'min(WIDTH,iw)':-2"</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>14.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>height: –vf scale="'min(WIDTH,iw)': 'min(HEIGHT,ih)'"</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>15.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>profilelevelid: calculate the profile,pixelformat and level from this if set</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>16.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>profile: -profile:v H264_PROFILE </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>17.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>pixelfmt: -pix_fmt H264_PIXELFORMAT</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>18.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>level: suggested H.264 level. -level:v H264_LEVELH264_EXTRA</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>19.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>pm: if 0: -rtpflags h264_mode0</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>20.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>sprop: not supported by ffmpeg (should use in-band)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>21.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>srtp_alg: haven’t checked. See the ffmpeg documentation.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>22.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>srtp_key: haven’t checked. See the ffmpeg documentation.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>23.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>srtp_remotekey: haven’t checked. See the ffmpeg documentation.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>24.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>device: -i video="CAMERADEVICENAME"</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-style:normal'>25.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>fmtp: not applicable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-size:9.0pt;font-style:normal'>FFplay parameters</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>To simplify the video player usage, you can ignore the VIDEO notification parameters and just pass the generated video_play.sdp to ffplay.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: instead of using ffplay (which is just a playback specific variant for ffmpeg), you might use ffmpeg also for playback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>See the </span><a href="https://ffmpeg.org/documentation.html"><span style='font-size:9.0pt; font-style:normal'>ffmpeg documentation</span></a><span style='font-size:9.0pt; font-style:normal'> for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.mizu-voip.com/"><span style='font-size:8.0pt; color:#4A442A;text-decoration:none'>© Mizutech SRL</span></a></p> </div>
Contents
Topics
Search
About
Usage
Mode
UDP
API
Parameters
API
Notifications
Pseudocode
Relay
Recording
FFmpeg
About
API
API
FFmpeg
Mode
Notifications
Parameters
Pseudocode
Recording
Relay
UDP
Usage
Java SIP Video Streaming
