Skip to content

Commit

Permalink
Fix circular dependency & update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Santiago Souto committed Dec 29, 2023
1 parent 90cfd71 commit f64eed7
Show file tree
Hide file tree
Showing 15 changed files with 94 additions and 122 deletions.
7 changes: 3 additions & 4 deletions packages/millicast-sdk/docs-translations/en/Director.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
{
"<p>WebSocket available URLs.</p>": "<p>WebSocket available URLs.</p>",
"<p>Access token for signaling initialization.</p>": "<p>Access token for signaling initialization.</p>",
"<p>Object which represents a list of Ice servers.</p>": "<p>Object which represents a list of Ice servers.</p>",
"<p>Millicast Publishing Token.</p>": "<p>Millicast Publishing Token.</p>",
"<p>Millicast Stream Name.</p>": "<p>Millicast Stream Name.</p>",
"<p>Millicast Stream Type.</p>": "<p>Millicast Stream Type.</p>",
"<p>Millicast publisher Stream Name.</p>": "<p>Millicast publisher Stream Name.</p>",
"<p>Millicast Account ID.</p>": "<p>Millicast Account ID.</p>",
"<p>Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param.</p>": "<p>Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param.</p>",
"<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://dash.millicast.com/docs.html?pg=managing-your-tokens\">Managing Your Tokens</a>.</p>": "<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://dash.millicast.com/docs.html?pg=managing-your-tokens\">Managing Your Tokens</a>.</p>",
"<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://docs.dolby.io/streaming-apis/docs/managing-your-tokens\">Managing Your Tokens</a>.</p>": "<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://docs.dolby.io/streaming-apis/docs/managing-your-tokens\">Managing Your Tokens</a>.</p>",
"<p>Set Director API endpoint where requests will be sent.</p>": "<p>Set Director API endpoint where requests will be sent.</p>",
"<p>New Director API endpoint</p>": "<p>New Director API endpoint</p>",
"<p>Get current Director API endpoint where requests will be sent.</p>\n<p>By default, https://director.millicast.com is the current API endpoint.</p>": "<p>Get current Director API endpoint where requests will be sent.</p>\n<p>By default, https://director.millicast.com is the current API endpoint.</p>",
Expand All @@ -25,7 +26,5 @@
"<p>Millicast options or <em>Deprecated Millicast publisher Stream Name.</em></p>": "<p>Millicast options or <em>Deprecated Millicast publisher Stream Name.</em></p>",
"<p><em>Deprecated, use options parameter instead</em> Millicast Account ID.</p>": "<p><em>Deprecated, use options parameter instead</em> Millicast Account ID.</p>",
"<p><em>Deprecated, use options parameter instead</em> Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param.</p>": "<p><em>Deprecated, use options parameter instead</em> Token to subscribe to secure streams. If you are subscribing to an unsecure stream, you can omit this param.</p>",
"<p>Promise object which represents the result of getting the subscribe connection data.</p>": "<p>Promise object which represents the result of getting the subscribe connection data.</p>",
"<p>Object which represents a list of Ice servers.</p>": "<p>Object which represents a list of Ice servers.</p>",
"<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://docs.dolby.io/streaming-apis/docs/managing-your-tokens\">Managing Your Tokens</a>.</p>": "<p>Simplify API calls to find the best server and region to publish and subscribe to.\nFor security reasons all calls will return a <a href=\"https://jwt.io\">JWT</a> token for authentication including the required\nsocket path to connect with.</p>\n<p>You will need your own Publishing token and Stream name, please refer to <a href=\"https://docs.millicast.com/docs/managing-your-tokens\">Managing Your Tokens</a>.</p>"
"<p>Promise object which represents the result of getting the subscribe connection data.</p>": "<p>Promise object which represents the result of getting the subscribe connection data.</p>"
}
21 changes: 5 additions & 16 deletions packages/millicast-sdk/docs-translations/en/PeerConnection.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
{
"<p>Manages WebRTC connection and SDP information between peers.</p>": "<p>Manages WebRTC connection and SDP information between peers.</p>",
"<p>Set TURN server location.</p>": "<p>Set TURN server location.</p>",
"<p>New TURN location</p>": "<p>New TURN location</p>",
"<p>Get current TURN location.</p>\n<p>By default, https://turn.millicast.com/webrtc/_turn is the current TURN location.</p>": "<p>Get current TURN location.</p>\n<p>By default, https://turn.millicast.com/webrtc/_turn is the current TURN location.</p>",
"<p>TURN url</p>": "<p>TURN url</p>",
"<p>Instance new RTCPeerConnection.</p>": "<p>Instance new RTCPeerConnection.</p>",
"<p>Peer configuration.</p>": "<p>Peer configuration.</p>",
"<p>Get current RTC peer connection.</p>": "<p>Get current RTC peer connection.</p>",
"<p>Object which represents the RTCPeerConnection.</p>": "<p>Object which represents the RTCPeerConnection.</p>",
"<p>Close RTC peer connection.</p>": "<p>Close RTC peer connection.</p>",
"<p>Get default RTC configuration with ICE servers from Milicast signaling server and merge it with the user configuration provided. User configuration has priority over defaults.</p>": "<p>Get default RTC configuration with ICE servers from Milicast signaling server and merge it with the user configuration provided. User configuration has priority over defaults.</p>",
"<p>Options to configure the new RTCPeerConnection.</p>": "<p>Options to configure the new RTCPeerConnection.</p>",
"<p>Promise object which represents the RTCConfiguration.</p>": "<p>Promise object which represents the RTCConfiguration.</p>",
"<p>Get Ice servers from a Millicast signaling server.</p>": "<p>Get Ice servers from a Millicast signaling server.</p>",
"<p><em>Deprecated, use .setTurnServerLocation() method instead</em> URL of signaling server where Ice servers will be obtained.</p>": "<p><em>Deprecated, use .setTurnServerLocation() method instead</em> URL of signaling server where Ice servers will be obtained.</p>",
"<p>Promise object which represents a list of Ice servers.</p>": "<p>Promise object which represents a list of Ice servers.</p>",
"<p>Set SDP information to remote peer.</p>": "<p>Set SDP information to remote peer.</p>",
"<p>New SDP to be set in the remote peer.</p>": "<p>New SDP to be set in the remote peer.</p>",
"<p>Promise object which resolves when SDP information was successfully set.</p>": "<p>Promise object which resolves when SDP information was successfully set.</p>",
Expand All @@ -25,13 +15,16 @@
"<p>Selected codec for support simulcast.</p>": "<p>Selected codec for support simulcast.</p>",
"<p>True to modify SDP for support simulcast. <strong>Only available in Google Chrome and with H.264 or VP8 video codecs.</strong></p>": "<p>True to modify SDP for support simulcast. <strong>Only available in Google Chrome and with H.264 or VP8 video codecs.</strong></p>",
"<p>Selected scalability mode. You can get the available capabilities using <a href=\"PeerConnection#.getCapabilities\">PeerConnection.getCapabilities</a> method.\n<strong>Only available in Google Chrome.</strong></p>": "<p>Selected scalability mode. You can get the available capabilities using <a href=\"PeerConnection#.getCapabilities\">PeerConnection.getCapabilities</a> method.\n<strong>Only available in Google Chrome.</strong></p>",
"<p>True to modify SDP for supporting absolute capture time header extension. Otherwise False.</p>": "<p>True to modify SDP for supporting absolute capture time header extension. Otherwise False.</p>",
"<p>True to modify SDP for supporting aom dependency descriptor header extension. Otherwise False.</p>": "<p>True to modify SDP for supporting aom dependency descriptor header extension. Otherwise False.</p>",
"<p>True to not support audio.</p>": "<p>True to not support audio.</p>",
"<p>True to not support video.</p>": "<p>True to not support video.</p>",
"<p>True to set the SDP to local peer.</p>": "<p>True to set the SDP to local peer.</p>",
"<p>Promise object which represents the SDP information of the created offer.</p>": "<p>Promise object which represents the SDP information of the created offer.</p>",
"<p>Add remote receving track.</p>": "<p>Add remote receving track.</p>",
"<p>Media kind ('audio' | 'video').</p>": "<p>Media kind ('audio' | 'video').</p>",
"<p>streams - Streams the stream will belong to.</p>": "<p>streams - Streams the stream will belong to.</p>",
"<p>Streams the track will belong to.</p>": "<p>Streams the track will belong to.</p>",
"<p>Promise that will be resolved when the RTCRtpTransceiver is assigned an mid value.</p>": "<p>Promise that will be resolved when the RTCRtpTransceiver is assigned an mid value.</p>",
"<p>Update remote SDP information to restrict bandwidth.</p>": "<p>Update remote SDP information to restrict bandwidth.</p>",
"<p>Remote SDP.</p>": "<p>Remote SDP.</p>",
"<p>New bitrate value in kbps or 0 unlimited bitrate.</p>": "<p>New bitrate value in kbps or 0 unlimited bitrate.</p>",
Expand All @@ -58,9 +51,5 @@
"<p>PeerConnection instance.</p>": "<p>PeerConnection instance.</p>",
"<p>Peer instance.</p>": "<p>Peer instance.</p>",
"<p>New track event.</p>": "<p>New track event.</p>",
"<p>Peer connection state change. Could be new, connecting, connected, disconnected, failed or closed.</p>": "<p>Peer connection state change. Could be new, connecting, connected, disconnected, failed or closed.</p>",
"<p>True to modify SDP for supporting absolute capture time header extension. Otherwise False.</p>": "<p>True to modify SDP for supporting absolute capture time header extension. Otherwise False.</p>",
"<p>True to modify SDP for supporting aom dependency descriptor header extension. Otherwise False.</p>": "<p>True to modify SDP for supporting aom dependency descriptor header extension. Otherwise False.</p>",
"<p>Streams the track will belong to.</p>": "<p>Streams the track will belong to.</p>",
"<p>Promise that will be resolved when the RTCRtpTransceiver is assigned an mid value.</p>": "<p>Promise that will be resolved when the RTCRtpTransceiver is assigned an mid value.</p>"
"<p>Peer connection state change. Could be new, connecting, connected, disconnected, failed or closed.</p>": "<p>Peer connection state change. Could be new, connecting, connected, disconnected, failed or closed.</p>"
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"<p>Current round trip time indicate the number of seconds it takes for data to be sent by this peer to the remote peer and back over the connection described by this pair of ICE candidates.</p>\n<p>This value comes from the nominated candidate-pair.</p>": "<p>Current round trip time indicate the number of seconds it takes for data to be sent by this peer to the remote peer and back over the connection described by this pair of ICE candidates.</p>\n<p>This value comes from the nominated candidate-pair.</p>",
"<p>Local candidate type from the nominated candidate-pair which indicates the type of ICE candidate the object represents.</p>": "<p>Local candidate type from the nominated candidate-pair which indicates the type of ICE candidate the object represents.</p>",
"<p>Parsed information of each inbound-rtp.</p>": "<p>Parsed information of each inbound-rtp.</p>",
"<p>Parsed information of each outbound-rtp.</p>": "<p>Parsed information of each outbound-rtp.</p>",
"<p>inbound-rtp Id.</p>": "<p>inbound-rtp Id.</p>",
"<p>Current Jitter measured in seconds.</p>": "<p>Current Jitter measured in seconds.</p>",
"<p>Mime type if related report had codec report associated.</p>": "<p>Mime type if related report had codec report associated.</p>",
Expand All @@ -20,7 +21,6 @@
"<p>Total packet lost ratio per second.</p>": "<p>Total packet lost ratio per second.</p>",
"<p>Total packet lost delta per second.</p>": "<p>Total packet lost delta per second.</p>",
"<p>Current bitrate in bits per second.</p>": "<p>Current bitrate in bits per second.</p>",
"<p>Parsed information of each outbound-rtp.</p>": "<p>Parsed information of each outbound-rtp.</p>",
"<p>outbound-rtp Id.</p>": "<p>outbound-rtp Id.</p>",
"<p>If it's video report, indicate the reason why the media quality in the stream is currently being reduced by the codec during encoding, or none if no quality reduction is being performed.</p>": "<p>If it's video report, indicate the reason why the media quality in the stream is currently being reduced by the codec during encoding, or none if no quality reduction is being performed.</p>",
"<p>Total bytes sent indicates the total number of payload bytes that hve been sent so far on the connection described by the candidate pair.</p>": "<p>Total bytes sent indicates the total number of payload bytes that hve been sent so far on the connection described by the candidate pair.</p>",
Expand Down
Loading

0 comments on commit f64eed7

Please # to comment.