From d70aea543918946b8c498649405a44b4b3677b27 Mon Sep 17 00:00:00 2001 From: shinyoshiaki Date: Sun, 13 Oct 2024 14:50:38 +0900 Subject: [PATCH] update docs --- doc/.nojekyll | 1 - doc/README.md | 4 +- doc/classes/AV1Obu.md | 64 +- doc/classes/AV1RtpPayload.md | 80 +- doc/classes/BitStream.md | 64 +- doc/classes/BitWriter.md | 48 +- doc/classes/BitWriter2.md | 52 +- doc/classes/BufferChain.md | 53 +- doc/classes/Candidate.md | 134 +- doc/classes/CandidatePair.md | 122 +- doc/classes/Connection.md | 341 +-- doc/classes/DePacketizerBase.md | 66 +- doc/classes/Event.md | 349 +++ doc/classes/EventDisposer.md | 41 + doc/classes/GenericNack.md | 96 +- doc/classes/GroupDescription.md | 38 +- doc/classes/H264RtpPayload.md | 107 +- doc/classes/IceCandidate.md | 120 +- doc/classes/MediaDescription.md | 172 +- doc/classes/MediaStream.md | 68 +- doc/classes/MediaStreamTrack.md | 652 +++-- doc/classes/MediaStreamTrackFactory.md | 34 +- doc/classes/Message.md | 219 ++ doc/classes/OpusRtpPayload.md | 66 +- doc/classes/PacketResult.md | 39 +- doc/classes/PictureLossIndication.md | 63 +- doc/classes/PromiseQueue.md | 50 +- doc/classes/RTCCertificate.md | 53 +- doc/classes/RTCDataChannel.md | 729 +++--- doc/classes/RTCDataChannelParameters.md | 58 +- doc/classes/RTCDtlsFingerprint.md | 32 +- doc/classes/RTCDtlsParameters.md | 32 +- doc/classes/RTCDtlsTransport.md | 215 +- doc/classes/RTCIceCandidate.md | 77 +- doc/classes/RTCIceGatherer.md | 72 +- doc/classes/RTCIceParameters.md | 34 +- doc/classes/RTCIceTransport.md | 89 +- doc/classes/RTCPeerConnection.md | 878 +++---- doc/classes/RTCRtcpFeedback.md | 31 +- doc/classes/RTCRtcpParameters.md | 38 +- doc/classes/RTCRtpCodecParameters.md | 74 +- doc/classes/RTCRtpCodingParameters.md | 36 +- .../RTCRtpHeaderExtensionParameters.md | 29 +- doc/classes/RTCRtpReceiver.md | 306 +-- doc/classes/RTCRtpRtxParameters.md | 24 +- doc/classes/RTCRtpSender.md | 240 +- doc/classes/RTCRtpSimulcastParameters.md | 29 +- doc/classes/RTCRtpTransceiver.md | 206 +- doc/classes/RTCSctpCapabilities.md | 24 +- doc/classes/RTCSctpTransport.md | 178 +- doc/classes/RTCSessionDescription.md | 46 +- doc/classes/ReceiverEstimatedMaxBitrate.md | 93 +- doc/classes/RecvDelta.md | 73 +- doc/classes/Red.md | 44 +- doc/classes/RedEncoder.md | 57 +- doc/classes/RedHandler.md | 29 +- doc/classes/RedHeader.md | 39 +- doc/classes/RtcpHeader.md | 63 +- doc/classes/RtcpPacketConverter.md | 48 +- doc/classes/RtcpPayloadSpecificFeedback.md | 56 +- doc/classes/RtcpReceiverInfo.md | 118 +- doc/classes/RtcpRrPacket.md | 61 +- doc/classes/RtcpSenderInfo.md | 78 +- doc/classes/RtcpSourceDescriptionPacket.md | 62 +- doc/classes/RtcpSrPacket.md | 101 +- doc/classes/RtcpTransportLayerFeedback.md | 61 +- doc/classes/RtpBuilder.md | 47 +- doc/classes/RtpHeader.md | 125 +- doc/classes/RtpPacket.md | 71 +- doc/classes/RunLengthChunk.md | 64 +- doc/classes/SessionDescription.md | 135 +- doc/classes/SourceDescriptionChunk.md | 54 +- doc/classes/SourceDescriptionItem.md | 54 +- doc/classes/SrtcpSession.md | 115 +- doc/classes/SrtpSession.md | 118 +- doc/classes/SsrcDescription.md | 52 +- doc/classes/StatusVectorChunk.md | 53 +- doc/classes/StunOverTurnProtocol.md | 149 ++ doc/classes/StunProtocol.md | 219 ++ doc/classes/TcpTransport.md | 95 + doc/classes/TransportWideCC.md | 107 +- doc/classes/TurnProtocol.md | 293 +++ doc/classes/UdpTransport.md | 109 + doc/classes/Vp8RtpPayload.md | 168 +- doc/classes/Vp9RtpPayload.md | 231 +- doc/classes/WeriftError.md | 152 +- doc/enumerations/CandidatePairState.md | 37 + doc/enumerations/PacketChunk.md | 25 + doc/enumerations/PacketStatus.md | 31 + doc/enumerations/classes.md | 31 + doc/enumerations/methods.md | 55 + doc/enums/CandidatePairState.md | 43 - doc/enums/PacketChunk.md | 29 - doc/enums/PacketStatus.md | 36 - doc/functions/Int.md | 17 + doc/functions/addSDPHeader.md | 19 + doc/functions/addTransportDescription.md | 19 + doc/functions/allocateMid.md | 19 + doc/functions/andDirection.md | 19 + doc/functions/buffer2ArrayBuffer.md | 17 + doc/functions/bufferArrayXor.md | 17 + doc/functions/bufferReader.md | 19 + doc/functions/bufferWriter.md | 19 + doc/functions/bufferWriterLE.md | 19 + doc/functions/bufferXor.md | 19 + doc/functions/candidateFoundation.md | 21 + doc/functions/candidateFromIce.md | 17 + doc/functions/candidateFromSdp.md | 17 + doc/functions/candidatePairPriority.md | 21 + doc/functions/candidatePriority.md | 19 + doc/functions/candidateToIce.md | 17 + doc/functions/candidateToSdp.md | 17 + doc/functions/codecParametersFromString.md | 17 + doc/functions/codecParametersToString.md | 19 + doc/functions/compactNtp.md | 21 + doc/functions/createBufferWriter.md | 27 + .../createMediaDescriptionForSctp.md | 17 + .../createMediaDescriptionForTransceiver.md | 21 + doc/functions/createSelfSignedCertificate.md | 39 + doc/functions/createStunOverTurnClient.md | 37 + doc/functions/createTurnClient.md | 19 + doc/functions/dePacketizeRtpPackets.md | 41 + doc/functions/deepMerge.md | 23 + doc/functions/deserializeAbsSendTime.md | 17 + .../deserializeAudioLevelIndication.md | 17 + doc/functions/deserializeString.md | 17 + doc/functions/deserializeUint16BE.md | 17 + doc/functions/dumpBuffer.md | 17 + doc/functions/enumerate.md | 21 + doc/functions/findCodecByMimeType.md | 19 + doc/functions/findPort.md | 23 + doc/functions/fingerprint.md | 19 + doc/functions/getBit.md | 21 + doc/functions/getGlobalIp.md | 19 + doc/functions/getHostAddresses.md | 19 + doc/functions/growBufferSize.md | 19 + doc/functions/int-1.md | 17 + doc/functions/interfaceAddress.md | 19 + doc/functions/isDtls.md | 17 + doc/functions/isMedia.md | 17 + doc/functions/isRtcp.md | 17 + doc/functions/leb128decode.md | 17 + doc/functions/makeIntegrityKey.md | 21 + doc/functions/microTime.md | 13 + doc/functions/milliTime.md | 13 + doc/functions/normalizeFamilyNodeV18.md | 17 + doc/functions/ntpTime.md | 15 + doc/functions/ntpTime2Sec.md | 17 + doc/functions/paddingBits.md | 19 + doc/functions/paddingByte.md | 17 + doc/functions/paddingLength.md | 17 + doc/functions/parseGroup.md | 21 + doc/functions/parseIceServers.md | 33 + doc/functions/parseMessage.md | 19 + doc/functions/random16.md | 13 + doc/functions/random32.md | 13 + doc/functions/randomPort.md | 19 + doc/functions/randomPorts.md | 21 + doc/functions/reverseDirection.md | 17 + doc/functions/reverseSimulcastDirection.md | 17 + doc/functions/rtpHeaderExtensionsParser.md | 19 + doc/functions/serializeAbsSendTime.md | 17 + .../serializeAudioLevelIndication.md | 17 + doc/functions/serializeRepairedRtpStreamId.md | 17 + doc/functions/serializeSdesMid.md | 17 + doc/functions/serializeSdesRTPStreamID.md | 17 + doc/functions/serializeTransportWideCC.md | 17 + doc/functions/serverReflexiveCandidate.md | 19 + doc/functions/sortCandidatePairs.md | 19 + doc/functions/timestampSeconds.md | 13 + doc/functions/uint16Add.md | 19 + doc/functions/uint16Gt.md | 21 + doc/functions/uint16Gte.md | 21 + doc/functions/uint24.md | 17 + doc/functions/uint32Add.md | 19 + doc/functions/uint32Gt.md | 21 + doc/functions/uint32Gte.md | 21 + doc/functions/uint8Add.md | 19 + doc/functions/unwrapRtx.md | 21 + doc/functions/url2Address.md | 17 + doc/functions/useAbsSendTime.md | 13 + doc/functions/useAudioLevelIndication.md | 13 + doc/functions/useDependencyDescriptor.md | 13 + doc/functions/useFIR.md | 13 + doc/functions/useNACK.md | 13 + doc/functions/usePLI.md | 13 + doc/functions/useREMB.md | 13 + doc/functions/useRepairedRtpStreamId.md | 13 + doc/functions/useSdesMid.md | 13 + doc/functions/useSdesRTPStreamId.md | 13 + doc/functions/useTWCC.md | 13 + doc/functions/useTransportWideCC.md | 13 + doc/functions/validateAddress.md | 17 + doc/functions/validateRemoteCandidate.md | 17 + doc/functions/wrapRtx.md | 23 + doc/globals.md | 295 +++ doc/interfaces/IceOptions.md | 136 +- doc/interfaces/MessageEvent.md | 12 +- doc/interfaces/PeerConfig.md | 141 +- doc/interfaces/Protocol.md | 136 +- doc/interfaces/RTCDataChannelEvent.md | 12 +- doc/interfaces/RTCErrorEvent.md | 12 +- doc/interfaces/RTCPeerConnectionIceEvent.md | 14 +- doc/interfaces/RTCRtpParameters.md | 51 +- doc/interfaces/RTCRtpReceiveParameters.md | 68 +- doc/interfaces/RTCSessionDescriptionInit.md | 19 +- doc/interfaces/RTCTrackEvent.md | 27 +- doc/interfaces/TransceiverOptions.md | 17 +- doc/interfaces/Transport.md | 55 + doc/interfaces/TurnClientConfig.md | 25 + doc/interfaces/TurnClientOptions.md | 37 + doc/modules.md | 2255 ----------------- doc/type-aliases/Address.md | 9 + .../AudioLevelIndicationPayload.md | 19 + doc/type-aliases/BundlePolicy.md | 9 + doc/type-aliases/CipherSuites.md | 9 + doc/type-aliases/ConnectionState.md | 9 + doc/type-aliases/CurveTypes.md | 9 + doc/type-aliases/DCState.md | 9 + doc/type-aliases/DepacketizerCodec.md | 9 + doc/type-aliases/Direction.md | 9 + doc/type-aliases/DtlsKeys.md | 23 + doc/type-aliases/DtlsRole.md | 9 + doc/type-aliases/DtlsState.md | 9 + doc/type-aliases/Extension.md | 19 + doc/type-aliases/HashAlgorithms.md | 9 + doc/type-aliases/IceGathererState.md | 9 + doc/type-aliases/InterfaceAddresses.md | 9 + doc/type-aliases/Kind.md | 9 + doc/type-aliases/NamedCurveAlgorithms.md | 9 + doc/type-aliases/RTCIceConnectionState.md | 9 + doc/type-aliases/RTCIceServer.md | 23 + doc/type-aliases/RTCPFB.md | 19 + doc/type-aliases/RTCRtpSendParameters.md | 9 + doc/type-aliases/RTCSdpType.md | 9 + doc/type-aliases/RTCSignalingState.md | 9 + doc/type-aliases/RequireAtLeastOne.md | 13 + doc/type-aliases/RtcpPacket.md | 9 + doc/type-aliases/SignatureAlgorithms.md | 9 + doc/type-aliases/SignatureHash.md | 19 + doc/type-aliases/SignatureSchemes.md | 9 + doc/type-aliases/TransportWideCCPayload.md | 9 + doc/variables/AttributeKeys.md | 9 + doc/variables/COOKIE.md | 9 + doc/variables/CipherSuite.md | 19 + doc/variables/CipherSuiteList.md | 9 + doc/variables/ConnectionStates.md | 9 + doc/variables/CurveType.md | 15 + doc/variables/Directions.md | 9 + doc/variables/DtlsStates.md | 9 + doc/variables/ExtensionProfiles.md | 19 + doc/variables/FINGERPRINT_LENGTH.md | 9 + doc/variables/FINGERPRINT_XOR.md | 9 + doc/variables/HEADER_LENGTH.md | 9 + doc/variables/HashAlgorithm.md | 15 + doc/variables/INTEGRITY_LENGTH.md | 9 + doc/variables/IPV4_PROTOCOL.md | 9 + doc/variables/IPV6_PROTOCOL.md | 9 + doc/variables/IceGathererStates.md | 9 + doc/variables/IceTransportStates.md | 9 + doc/variables/Inactive.md | 9 + doc/variables/NalUnitType.md | 39 + doc/variables/NamedCurveAlgorithm.md | 19 + doc/variables/NamedCurveAlgorithmList.md | 9 + doc/variables/RETRY_MAX.md | 9 + doc/variables/RETRY_RTO.md | 9 + doc/variables/RTCP_HEADER_SIZE.md | 9 + doc/variables/RTP_EXTENSION_URI.md | 39 + doc/variables/Recvonly.md | 9 + doc/variables/Sendonly.md | 9 + doc/variables/Sendrecv.md | 9 + doc/variables/SignalingStates.md | 9 + doc/variables/SignatureAlgorithm.md | 19 + doc/variables/SignatureScheme.md | 19 + doc/variables/certificateTypes.md | 9 + doc/variables/defaultPeerConfig.md | 9 + doc/variables/depacketizerCodecs.md | 9 + doc/variables/signatures.md | 9 + doc/variables/timer.md | 43 + packages/ice/doc/README.md | 8 + packages/ice/doc/classes/Candidate.md | 145 ++ packages/ice/doc/classes/CandidatePair.md | 145 ++ packages/ice/doc/classes/Connection.md | 341 +++ packages/ice/doc/classes/Message.md | 219 ++ .../ice/doc/classes/StunOverTurnProtocol.md | 149 ++ packages/ice/doc/classes/StunProtocol.md | 219 ++ packages/ice/doc/classes/TcpTransport.md | 95 + packages/ice/doc/classes/TurnProtocol.md | 293 +++ packages/ice/doc/classes/UdpTransport.md | 109 + .../doc/enumerations/CandidatePairState.md | 37 + packages/ice/doc/enumerations/classes.md | 31 + packages/ice/doc/enumerations/methods.md | 55 + .../ice/doc/functions/candidateFoundation.md | 21 + .../doc/functions/candidatePairPriority.md | 21 + .../ice/doc/functions/candidatePriority.md | 19 + .../doc/functions/createStunOverTurnClient.md | 37 + .../ice/doc/functions/createTurnClient.md | 19 + packages/ice/doc/functions/getGlobalIp.md | 19 + .../ice/doc/functions/getHostAddresses.md | 19 + .../ice/doc/functions/makeIntegrityKey.md | 21 + .../doc/functions/normalizeFamilyNodeV18.md | 17 + packages/ice/doc/functions/paddingLength.md | 17 + packages/ice/doc/functions/parseMessage.md | 19 + packages/ice/doc/functions/randomPort.md | 19 + .../doc/functions/serverReflexiveCandidate.md | 19 + .../ice/doc/functions/sortCandidatePairs.md | 19 + packages/ice/doc/functions/url2Address.md | 17 + packages/ice/doc/functions/validateAddress.md | 17 + .../doc/functions/validateRemoteCandidate.md | 17 + packages/ice/doc/globals.md | 68 + packages/ice/doc/interfaces/IceOptions.md | 111 + packages/ice/doc/interfaces/Protocol.md | 113 + packages/ice/doc/interfaces/Transport.md | 55 + .../ice/doc/interfaces/TurnClientConfig.md | 25 + .../ice/doc/interfaces/TurnClientOptions.md | 37 + packages/ice/doc/type-aliases/Address.md | 9 + packages/ice/doc/variables/AttributeKeys.md | 9 + packages/ice/doc/variables/COOKIE.md | 9 + .../ice/doc/variables/FINGERPRINT_LENGTH.md | 9 + packages/ice/doc/variables/FINGERPRINT_XOR.md | 9 + packages/ice/doc/variables/HEADER_LENGTH.md | 9 + .../ice/doc/variables/INTEGRITY_LENGTH.md | 9 + packages/ice/doc/variables/IPV4_PROTOCOL.md | 9 + packages/ice/doc/variables/IPV6_PROTOCOL.md | 9 + packages/ice/doc/variables/RETRY_MAX.md | 9 + packages/ice/doc/variables/RETRY_RTO.md | 9 + packages/ice/package.json | 3 +- packages/rtp/doc/.nojekyll | 1 - packages/rtp/doc/README.md | 4 +- packages/rtp/doc/classes/AV1Obu.md | 64 +- packages/rtp/doc/classes/AV1RtpPayload.md | 80 +- packages/rtp/doc/classes/BitStream.md | 64 +- packages/rtp/doc/classes/BitWriter.md | 48 +- packages/rtp/doc/classes/BitWriter2.md | 52 +- packages/rtp/doc/classes/BufferChain.md | 53 +- packages/rtp/doc/classes/DePacketizerBase.md | 66 +- packages/rtp/doc/classes/Event.md | 349 +++ packages/rtp/doc/classes/EventDisposer.md | 41 + packages/rtp/doc/classes/GenericNack.md | 96 +- packages/rtp/doc/classes/H264RtpPayload.md | 107 +- packages/rtp/doc/classes/OpusRtpPayload.md | 66 +- packages/rtp/doc/classes/PacketResult.md | 39 +- .../rtp/doc/classes/PictureLossIndication.md | 63 +- packages/rtp/doc/classes/PromiseQueue.md | 50 +- .../classes/ReceiverEstimatedMaxBitrate.md | 93 +- packages/rtp/doc/classes/RecvDelta.md | 73 +- packages/rtp/doc/classes/Red.md | 44 +- packages/rtp/doc/classes/RedEncoder.md | 57 +- packages/rtp/doc/classes/RedHandler.md | 29 +- packages/rtp/doc/classes/RedHeader.md | 39 +- packages/rtp/doc/classes/RtcpHeader.md | 63 +- .../rtp/doc/classes/RtcpPacketConverter.md | 48 +- .../classes/RtcpPayloadSpecificFeedback.md | 56 +- packages/rtp/doc/classes/RtcpReceiverInfo.md | 118 +- packages/rtp/doc/classes/RtcpRrPacket.md | 61 +- packages/rtp/doc/classes/RtcpSenderInfo.md | 78 +- .../classes/RtcpSourceDescriptionPacket.md | 62 +- packages/rtp/doc/classes/RtcpSrPacket.md | 101 +- .../doc/classes/RtcpTransportLayerFeedback.md | 61 +- packages/rtp/doc/classes/RtpBuilder.md | 47 +- packages/rtp/doc/classes/RtpHeader.md | 125 +- packages/rtp/doc/classes/RtpPacket.md | 71 +- packages/rtp/doc/classes/RunLengthChunk.md | 64 +- .../rtp/doc/classes/SourceDescriptionChunk.md | 54 +- .../rtp/doc/classes/SourceDescriptionItem.md | 54 +- packages/rtp/doc/classes/SrtcpSession.md | 115 +- packages/rtp/doc/classes/SrtpSession.md | 118 +- packages/rtp/doc/classes/StatusVectorChunk.md | 53 +- packages/rtp/doc/classes/TransportWideCC.md | 107 +- packages/rtp/doc/classes/Vp8RtpPayload.md | 168 +- packages/rtp/doc/classes/Vp9RtpPayload.md | 231 +- packages/rtp/doc/classes/WeriftError.md | 152 +- packages/rtp/doc/enumerations/PacketChunk.md | 25 + packages/rtp/doc/enumerations/PacketStatus.md | 31 + packages/rtp/doc/enums/PacketChunk.md | 29 - packages/rtp/doc/enums/PacketStatus.md | 36 - packages/rtp/doc/functions/Int.md | 17 + .../rtp/doc/functions/buffer2ArrayBuffer.md | 17 + packages/rtp/doc/functions/bufferArrayXor.md | 17 + packages/rtp/doc/functions/bufferReader.md | 19 + packages/rtp/doc/functions/bufferWriter.md | 19 + packages/rtp/doc/functions/bufferWriterLE.md | 19 + packages/rtp/doc/functions/bufferXor.md | 19 + .../rtp/doc/functions/createBufferWriter.md | 27 + .../doc/functions/dePacketizeRtpPackets.md | 41 + .../doc/functions/deserializeAbsSendTime.md | 17 + .../deserializeAudioLevelIndication.md | 17 + .../rtp/doc/functions/deserializeString.md | 17 + .../rtp/doc/functions/deserializeUint16BE.md | 17 + packages/rtp/doc/functions/dumpBuffer.md | 17 + packages/rtp/doc/functions/enumerate.md | 21 + packages/rtp/doc/functions/findPort.md | 23 + packages/rtp/doc/functions/getBit.md | 21 + packages/rtp/doc/functions/growBufferSize.md | 19 + packages/rtp/doc/functions/int-1.md | 17 + .../rtp/doc/functions/interfaceAddress.md | 19 + packages/rtp/doc/functions/isMedia.md | 17 + packages/rtp/doc/functions/isRtcp.md | 17 + packages/rtp/doc/functions/leb128decode.md | 17 + packages/rtp/doc/functions/ntpTime2Sec.md | 17 + packages/rtp/doc/functions/paddingBits.md | 19 + packages/rtp/doc/functions/paddingByte.md | 17 + packages/rtp/doc/functions/random16.md | 13 + packages/rtp/doc/functions/random32.md | 13 + packages/rtp/doc/functions/randomPort.md | 19 + packages/rtp/doc/functions/randomPorts.md | 21 + .../functions/rtpHeaderExtensionsParser.md | 19 + .../rtp/doc/functions/serializeAbsSendTime.md | 17 + .../serializeAudioLevelIndication.md | 17 + .../functions/serializeRepairedRtpStreamId.md | 17 + .../rtp/doc/functions/serializeSdesMid.md | 17 + .../doc/functions/serializeSdesRTPStreamID.md | 17 + .../doc/functions/serializeTransportWideCC.md | 17 + packages/rtp/doc/functions/uint16Add.md | 19 + packages/rtp/doc/functions/uint16Gt.md | 21 + packages/rtp/doc/functions/uint16Gte.md | 21 + packages/rtp/doc/functions/uint24.md | 17 + packages/rtp/doc/functions/uint32Add.md | 19 + packages/rtp/doc/functions/uint32Gt.md | 21 + packages/rtp/doc/functions/uint32Gte.md | 21 + packages/rtp/doc/functions/uint8Add.md | 19 + packages/rtp/doc/functions/unwrapRtx.md | 21 + packages/rtp/doc/functions/wrapRtx.md | 23 + packages/rtp/doc/globals.md | 125 + packages/rtp/doc/modules.md | 1064 -------- .../AudioLevelIndicationPayload.md | 19 + .../rtp/doc/type-aliases/DepacketizerCodec.md | 9 + packages/rtp/doc/type-aliases/Extension.md | 19 + .../doc/type-aliases/InterfaceAddresses.md | 9 + .../rtp/doc/type-aliases/RequireAtLeastOne.md | 13 + packages/rtp/doc/type-aliases/RtcpPacket.md | 9 + .../type-aliases/TransportWideCCPayload.md | 9 + .../rtp/doc/variables/ExtensionProfiles.md | 19 + packages/rtp/doc/variables/NalUnitType.md | 39 + .../rtp/doc/variables/RTCP_HEADER_SIZE.md | 9 + .../rtp/doc/variables/RTP_EXTENSION_URI.md | 39 + .../rtp/doc/variables/depacketizerCodecs.md | 9 + packages/rtp/doc/variables/timer.md | 43 + 438 files changed, 14101 insertions(+), 10988 deletions(-) delete mode 100644 doc/.nojekyll create mode 100644 doc/classes/Event.md create mode 100644 doc/classes/EventDisposer.md create mode 100644 doc/classes/Message.md create mode 100644 doc/classes/StunOverTurnProtocol.md create mode 100644 doc/classes/StunProtocol.md create mode 100644 doc/classes/TcpTransport.md create mode 100644 doc/classes/TurnProtocol.md create mode 100644 doc/classes/UdpTransport.md create mode 100644 doc/enumerations/CandidatePairState.md create mode 100644 doc/enumerations/PacketChunk.md create mode 100644 doc/enumerations/PacketStatus.md create mode 100644 doc/enumerations/classes.md create mode 100644 doc/enumerations/methods.md delete mode 100644 doc/enums/CandidatePairState.md delete mode 100644 doc/enums/PacketChunk.md delete mode 100644 doc/enums/PacketStatus.md create mode 100644 doc/functions/Int.md create mode 100644 doc/functions/addSDPHeader.md create mode 100644 doc/functions/addTransportDescription.md create mode 100644 doc/functions/allocateMid.md create mode 100644 doc/functions/andDirection.md create mode 100644 doc/functions/buffer2ArrayBuffer.md create mode 100644 doc/functions/bufferArrayXor.md create mode 100644 doc/functions/bufferReader.md create mode 100644 doc/functions/bufferWriter.md create mode 100644 doc/functions/bufferWriterLE.md create mode 100644 doc/functions/bufferXor.md create mode 100644 doc/functions/candidateFoundation.md create mode 100644 doc/functions/candidateFromIce.md create mode 100644 doc/functions/candidateFromSdp.md create mode 100644 doc/functions/candidatePairPriority.md create mode 100644 doc/functions/candidatePriority.md create mode 100644 doc/functions/candidateToIce.md create mode 100644 doc/functions/candidateToSdp.md create mode 100644 doc/functions/codecParametersFromString.md create mode 100644 doc/functions/codecParametersToString.md create mode 100644 doc/functions/compactNtp.md create mode 100644 doc/functions/createBufferWriter.md create mode 100644 doc/functions/createMediaDescriptionForSctp.md create mode 100644 doc/functions/createMediaDescriptionForTransceiver.md create mode 100644 doc/functions/createSelfSignedCertificate.md create mode 100644 doc/functions/createStunOverTurnClient.md create mode 100644 doc/functions/createTurnClient.md create mode 100644 doc/functions/dePacketizeRtpPackets.md create mode 100644 doc/functions/deepMerge.md create mode 100644 doc/functions/deserializeAbsSendTime.md create mode 100644 doc/functions/deserializeAudioLevelIndication.md create mode 100644 doc/functions/deserializeString.md create mode 100644 doc/functions/deserializeUint16BE.md create mode 100644 doc/functions/dumpBuffer.md create mode 100644 doc/functions/enumerate.md create mode 100644 doc/functions/findCodecByMimeType.md create mode 100644 doc/functions/findPort.md create mode 100644 doc/functions/fingerprint.md create mode 100644 doc/functions/getBit.md create mode 100644 doc/functions/getGlobalIp.md create mode 100644 doc/functions/getHostAddresses.md create mode 100644 doc/functions/growBufferSize.md create mode 100644 doc/functions/int-1.md create mode 100644 doc/functions/interfaceAddress.md create mode 100644 doc/functions/isDtls.md create mode 100644 doc/functions/isMedia.md create mode 100644 doc/functions/isRtcp.md create mode 100644 doc/functions/leb128decode.md create mode 100644 doc/functions/makeIntegrityKey.md create mode 100644 doc/functions/microTime.md create mode 100644 doc/functions/milliTime.md create mode 100644 doc/functions/normalizeFamilyNodeV18.md create mode 100644 doc/functions/ntpTime.md create mode 100644 doc/functions/ntpTime2Sec.md create mode 100644 doc/functions/paddingBits.md create mode 100644 doc/functions/paddingByte.md create mode 100644 doc/functions/paddingLength.md create mode 100644 doc/functions/parseGroup.md create mode 100644 doc/functions/parseIceServers.md create mode 100644 doc/functions/parseMessage.md create mode 100644 doc/functions/random16.md create mode 100644 doc/functions/random32.md create mode 100644 doc/functions/randomPort.md create mode 100644 doc/functions/randomPorts.md create mode 100644 doc/functions/reverseDirection.md create mode 100644 doc/functions/reverseSimulcastDirection.md create mode 100644 doc/functions/rtpHeaderExtensionsParser.md create mode 100644 doc/functions/serializeAbsSendTime.md create mode 100644 doc/functions/serializeAudioLevelIndication.md create mode 100644 doc/functions/serializeRepairedRtpStreamId.md create mode 100644 doc/functions/serializeSdesMid.md create mode 100644 doc/functions/serializeSdesRTPStreamID.md create mode 100644 doc/functions/serializeTransportWideCC.md create mode 100644 doc/functions/serverReflexiveCandidate.md create mode 100644 doc/functions/sortCandidatePairs.md create mode 100644 doc/functions/timestampSeconds.md create mode 100644 doc/functions/uint16Add.md create mode 100644 doc/functions/uint16Gt.md create mode 100644 doc/functions/uint16Gte.md create mode 100644 doc/functions/uint24.md create mode 100644 doc/functions/uint32Add.md create mode 100644 doc/functions/uint32Gt.md create mode 100644 doc/functions/uint32Gte.md create mode 100644 doc/functions/uint8Add.md create mode 100644 doc/functions/unwrapRtx.md create mode 100644 doc/functions/url2Address.md create mode 100644 doc/functions/useAbsSendTime.md create mode 100644 doc/functions/useAudioLevelIndication.md create mode 100644 doc/functions/useDependencyDescriptor.md create mode 100644 doc/functions/useFIR.md create mode 100644 doc/functions/useNACK.md create mode 100644 doc/functions/usePLI.md create mode 100644 doc/functions/useREMB.md create mode 100644 doc/functions/useRepairedRtpStreamId.md create mode 100644 doc/functions/useSdesMid.md create mode 100644 doc/functions/useSdesRTPStreamId.md create mode 100644 doc/functions/useTWCC.md create mode 100644 doc/functions/useTransportWideCC.md create mode 100644 doc/functions/validateAddress.md create mode 100644 doc/functions/validateRemoteCandidate.md create mode 100644 doc/functions/wrapRtx.md create mode 100644 doc/globals.md create mode 100644 doc/interfaces/Transport.md create mode 100644 doc/interfaces/TurnClientConfig.md create mode 100644 doc/interfaces/TurnClientOptions.md delete mode 100644 doc/modules.md create mode 100644 doc/type-aliases/Address.md create mode 100644 doc/type-aliases/AudioLevelIndicationPayload.md create mode 100644 doc/type-aliases/BundlePolicy.md create mode 100644 doc/type-aliases/CipherSuites.md create mode 100644 doc/type-aliases/ConnectionState.md create mode 100644 doc/type-aliases/CurveTypes.md create mode 100644 doc/type-aliases/DCState.md create mode 100644 doc/type-aliases/DepacketizerCodec.md create mode 100644 doc/type-aliases/Direction.md create mode 100644 doc/type-aliases/DtlsKeys.md create mode 100644 doc/type-aliases/DtlsRole.md create mode 100644 doc/type-aliases/DtlsState.md create mode 100644 doc/type-aliases/Extension.md create mode 100644 doc/type-aliases/HashAlgorithms.md create mode 100644 doc/type-aliases/IceGathererState.md create mode 100644 doc/type-aliases/InterfaceAddresses.md create mode 100644 doc/type-aliases/Kind.md create mode 100644 doc/type-aliases/NamedCurveAlgorithms.md create mode 100644 doc/type-aliases/RTCIceConnectionState.md create mode 100644 doc/type-aliases/RTCIceServer.md create mode 100644 doc/type-aliases/RTCPFB.md create mode 100644 doc/type-aliases/RTCRtpSendParameters.md create mode 100644 doc/type-aliases/RTCSdpType.md create mode 100644 doc/type-aliases/RTCSignalingState.md create mode 100644 doc/type-aliases/RequireAtLeastOne.md create mode 100644 doc/type-aliases/RtcpPacket.md create mode 100644 doc/type-aliases/SignatureAlgorithms.md create mode 100644 doc/type-aliases/SignatureHash.md create mode 100644 doc/type-aliases/SignatureSchemes.md create mode 100644 doc/type-aliases/TransportWideCCPayload.md create mode 100644 doc/variables/AttributeKeys.md create mode 100644 doc/variables/COOKIE.md create mode 100644 doc/variables/CipherSuite.md create mode 100644 doc/variables/CipherSuiteList.md create mode 100644 doc/variables/ConnectionStates.md create mode 100644 doc/variables/CurveType.md create mode 100644 doc/variables/Directions.md create mode 100644 doc/variables/DtlsStates.md create mode 100644 doc/variables/ExtensionProfiles.md create mode 100644 doc/variables/FINGERPRINT_LENGTH.md create mode 100644 doc/variables/FINGERPRINT_XOR.md create mode 100644 doc/variables/HEADER_LENGTH.md create mode 100644 doc/variables/HashAlgorithm.md create mode 100644 doc/variables/INTEGRITY_LENGTH.md create mode 100644 doc/variables/IPV4_PROTOCOL.md create mode 100644 doc/variables/IPV6_PROTOCOL.md create mode 100644 doc/variables/IceGathererStates.md create mode 100644 doc/variables/IceTransportStates.md create mode 100644 doc/variables/Inactive.md create mode 100644 doc/variables/NalUnitType.md create mode 100644 doc/variables/NamedCurveAlgorithm.md create mode 100644 doc/variables/NamedCurveAlgorithmList.md create mode 100644 doc/variables/RETRY_MAX.md create mode 100644 doc/variables/RETRY_RTO.md create mode 100644 doc/variables/RTCP_HEADER_SIZE.md create mode 100644 doc/variables/RTP_EXTENSION_URI.md create mode 100644 doc/variables/Recvonly.md create mode 100644 doc/variables/Sendonly.md create mode 100644 doc/variables/Sendrecv.md create mode 100644 doc/variables/SignalingStates.md create mode 100644 doc/variables/SignatureAlgorithm.md create mode 100644 doc/variables/SignatureScheme.md create mode 100644 doc/variables/certificateTypes.md create mode 100644 doc/variables/defaultPeerConfig.md create mode 100644 doc/variables/depacketizerCodecs.md create mode 100644 doc/variables/signatures.md create mode 100644 doc/variables/timer.md create mode 100644 packages/ice/doc/README.md create mode 100644 packages/ice/doc/classes/Candidate.md create mode 100644 packages/ice/doc/classes/CandidatePair.md create mode 100644 packages/ice/doc/classes/Connection.md create mode 100644 packages/ice/doc/classes/Message.md create mode 100644 packages/ice/doc/classes/StunOverTurnProtocol.md create mode 100644 packages/ice/doc/classes/StunProtocol.md create mode 100644 packages/ice/doc/classes/TcpTransport.md create mode 100644 packages/ice/doc/classes/TurnProtocol.md create mode 100644 packages/ice/doc/classes/UdpTransport.md create mode 100644 packages/ice/doc/enumerations/CandidatePairState.md create mode 100644 packages/ice/doc/enumerations/classes.md create mode 100644 packages/ice/doc/enumerations/methods.md create mode 100644 packages/ice/doc/functions/candidateFoundation.md create mode 100644 packages/ice/doc/functions/candidatePairPriority.md create mode 100644 packages/ice/doc/functions/candidatePriority.md create mode 100644 packages/ice/doc/functions/createStunOverTurnClient.md create mode 100644 packages/ice/doc/functions/createTurnClient.md create mode 100644 packages/ice/doc/functions/getGlobalIp.md create mode 100644 packages/ice/doc/functions/getHostAddresses.md create mode 100644 packages/ice/doc/functions/makeIntegrityKey.md create mode 100644 packages/ice/doc/functions/normalizeFamilyNodeV18.md create mode 100644 packages/ice/doc/functions/paddingLength.md create mode 100644 packages/ice/doc/functions/parseMessage.md create mode 100644 packages/ice/doc/functions/randomPort.md create mode 100644 packages/ice/doc/functions/serverReflexiveCandidate.md create mode 100644 packages/ice/doc/functions/sortCandidatePairs.md create mode 100644 packages/ice/doc/functions/url2Address.md create mode 100644 packages/ice/doc/functions/validateAddress.md create mode 100644 packages/ice/doc/functions/validateRemoteCandidate.md create mode 100644 packages/ice/doc/globals.md create mode 100644 packages/ice/doc/interfaces/IceOptions.md create mode 100644 packages/ice/doc/interfaces/Protocol.md create mode 100644 packages/ice/doc/interfaces/Transport.md create mode 100644 packages/ice/doc/interfaces/TurnClientConfig.md create mode 100644 packages/ice/doc/interfaces/TurnClientOptions.md create mode 100644 packages/ice/doc/type-aliases/Address.md create mode 100644 packages/ice/doc/variables/AttributeKeys.md create mode 100644 packages/ice/doc/variables/COOKIE.md create mode 100644 packages/ice/doc/variables/FINGERPRINT_LENGTH.md create mode 100644 packages/ice/doc/variables/FINGERPRINT_XOR.md create mode 100644 packages/ice/doc/variables/HEADER_LENGTH.md create mode 100644 packages/ice/doc/variables/INTEGRITY_LENGTH.md create mode 100644 packages/ice/doc/variables/IPV4_PROTOCOL.md create mode 100644 packages/ice/doc/variables/IPV6_PROTOCOL.md create mode 100644 packages/ice/doc/variables/RETRY_MAX.md create mode 100644 packages/ice/doc/variables/RETRY_RTO.md delete mode 100644 packages/rtp/doc/.nojekyll create mode 100644 packages/rtp/doc/classes/Event.md create mode 100644 packages/rtp/doc/classes/EventDisposer.md create mode 100644 packages/rtp/doc/enumerations/PacketChunk.md create mode 100644 packages/rtp/doc/enumerations/PacketStatus.md delete mode 100644 packages/rtp/doc/enums/PacketChunk.md delete mode 100644 packages/rtp/doc/enums/PacketStatus.md create mode 100644 packages/rtp/doc/functions/Int.md create mode 100644 packages/rtp/doc/functions/buffer2ArrayBuffer.md create mode 100644 packages/rtp/doc/functions/bufferArrayXor.md create mode 100644 packages/rtp/doc/functions/bufferReader.md create mode 100644 packages/rtp/doc/functions/bufferWriter.md create mode 100644 packages/rtp/doc/functions/bufferWriterLE.md create mode 100644 packages/rtp/doc/functions/bufferXor.md create mode 100644 packages/rtp/doc/functions/createBufferWriter.md create mode 100644 packages/rtp/doc/functions/dePacketizeRtpPackets.md create mode 100644 packages/rtp/doc/functions/deserializeAbsSendTime.md create mode 100644 packages/rtp/doc/functions/deserializeAudioLevelIndication.md create mode 100644 packages/rtp/doc/functions/deserializeString.md create mode 100644 packages/rtp/doc/functions/deserializeUint16BE.md create mode 100644 packages/rtp/doc/functions/dumpBuffer.md create mode 100644 packages/rtp/doc/functions/enumerate.md create mode 100644 packages/rtp/doc/functions/findPort.md create mode 100644 packages/rtp/doc/functions/getBit.md create mode 100644 packages/rtp/doc/functions/growBufferSize.md create mode 100644 packages/rtp/doc/functions/int-1.md create mode 100644 packages/rtp/doc/functions/interfaceAddress.md create mode 100644 packages/rtp/doc/functions/isMedia.md create mode 100644 packages/rtp/doc/functions/isRtcp.md create mode 100644 packages/rtp/doc/functions/leb128decode.md create mode 100644 packages/rtp/doc/functions/ntpTime2Sec.md create mode 100644 packages/rtp/doc/functions/paddingBits.md create mode 100644 packages/rtp/doc/functions/paddingByte.md create mode 100644 packages/rtp/doc/functions/random16.md create mode 100644 packages/rtp/doc/functions/random32.md create mode 100644 packages/rtp/doc/functions/randomPort.md create mode 100644 packages/rtp/doc/functions/randomPorts.md create mode 100644 packages/rtp/doc/functions/rtpHeaderExtensionsParser.md create mode 100644 packages/rtp/doc/functions/serializeAbsSendTime.md create mode 100644 packages/rtp/doc/functions/serializeAudioLevelIndication.md create mode 100644 packages/rtp/doc/functions/serializeRepairedRtpStreamId.md create mode 100644 packages/rtp/doc/functions/serializeSdesMid.md create mode 100644 packages/rtp/doc/functions/serializeSdesRTPStreamID.md create mode 100644 packages/rtp/doc/functions/serializeTransportWideCC.md create mode 100644 packages/rtp/doc/functions/uint16Add.md create mode 100644 packages/rtp/doc/functions/uint16Gt.md create mode 100644 packages/rtp/doc/functions/uint16Gte.md create mode 100644 packages/rtp/doc/functions/uint24.md create mode 100644 packages/rtp/doc/functions/uint32Add.md create mode 100644 packages/rtp/doc/functions/uint32Gt.md create mode 100644 packages/rtp/doc/functions/uint32Gte.md create mode 100644 packages/rtp/doc/functions/uint8Add.md create mode 100644 packages/rtp/doc/functions/unwrapRtx.md create mode 100644 packages/rtp/doc/functions/wrapRtx.md create mode 100644 packages/rtp/doc/globals.md delete mode 100644 packages/rtp/doc/modules.md create mode 100644 packages/rtp/doc/type-aliases/AudioLevelIndicationPayload.md create mode 100644 packages/rtp/doc/type-aliases/DepacketizerCodec.md create mode 100644 packages/rtp/doc/type-aliases/Extension.md create mode 100644 packages/rtp/doc/type-aliases/InterfaceAddresses.md create mode 100644 packages/rtp/doc/type-aliases/RequireAtLeastOne.md create mode 100644 packages/rtp/doc/type-aliases/RtcpPacket.md create mode 100644 packages/rtp/doc/type-aliases/TransportWideCCPayload.md create mode 100644 packages/rtp/doc/variables/ExtensionProfiles.md create mode 100644 packages/rtp/doc/variables/NalUnitType.md create mode 100644 packages/rtp/doc/variables/RTCP_HEADER_SIZE.md create mode 100644 packages/rtp/doc/variables/RTP_EXTENSION_URI.md create mode 100644 packages/rtp/doc/variables/depacketizerCodecs.md create mode 100644 packages/rtp/doc/variables/timer.md diff --git a/doc/.nojekyll b/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/doc/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/doc/README.md b/doc/README.md index 628de4d0f..7f007861d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,4 +1,6 @@ -werift / [Exports](modules.md) +**werift** • [**Docs**](globals.md) + +*** # werift diff --git a/doc/classes/AV1Obu.md b/doc/classes/AV1Obu.md index 382a7883e..03114d966 100644 --- a/doc/classes/AV1Obu.md +++ b/doc/classes/AV1Obu.md @@ -1,32 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / AV1Obu +[**werift**](../README.md) • **Docs** -# Class: AV1Obu - -## Table of contents - -### Constructors - -- [constructor](AV1Obu.md#constructor) +*** -### Properties +[werift](../globals.md) / AV1Obu -- [obu\_extension\_flag](AV1Obu.md#obu_extension_flag) -- [obu\_forbidden\_bit](AV1Obu.md#obu_forbidden_bit) -- [obu\_has\_size\_field](AV1Obu.md#obu_has_size_field) -- [obu\_reserved\_1bit](AV1Obu.md#obu_reserved_1bit) -- [obu\_type](AV1Obu.md#obu_type) -- [payload](AV1Obu.md#payload) - -### Methods - -- [serialize](AV1Obu.md#serialize) -- [deSerialize](AV1Obu.md#deserialize) +# Class: AV1Obu ## Constructors -### constructor +### new AV1Obu() -• **new AV1Obu**(): [`AV1Obu`](AV1Obu.md) +> **new AV1Obu**(): [`AV1Obu`](AV1Obu.md) #### Returns @@ -36,59 +20,57 @@ ### obu\_extension\_flag -• **obu\_extension\_flag**: `number` +> **obu\_extension\_flag**: `number` -___ +*** ### obu\_forbidden\_bit -• **obu\_forbidden\_bit**: `number` +> **obu\_forbidden\_bit**: `number` -___ +*** ### obu\_has\_size\_field -• **obu\_has\_size\_field**: `number` +> **obu\_has\_size\_field**: `number` -___ +*** ### obu\_reserved\_1bit -• **obu\_reserved\_1bit**: `number` +> **obu\_reserved\_1bit**: `number` -___ +*** ### obu\_type -• **obu\_type**: `OBU_TYPE` +> **obu\_type**: `OBU_TYPE` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md) +> `static` **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/doc/classes/AV1RtpPayload.md b/doc/classes/AV1RtpPayload.md index 0aa270fa9..f029d27c8 100644 --- a/doc/classes/AV1RtpPayload.md +++ b/doc/classes/AV1RtpPayload.md @@ -1,36 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / AV1RtpPayload +[**werift**](../README.md) • **Docs** -# Class: AV1RtpPayload - -## Table of contents - -### Constructors - -- [constructor](AV1RtpPayload.md#constructor) - -### Properties +*** -- [nBit\_RtpStartsNewCodedVideoSequence](AV1RtpPayload.md#nbit_rtpstartsnewcodedvideosequence) -- [obu\_or\_fragment](AV1RtpPayload.md#obu_or_fragment) -- [w\_RtpNumObus](AV1RtpPayload.md#w_rtpnumobus) -- [yBit\_RtpEndsWithFragment](AV1RtpPayload.md#ybit_rtpendswithfragment) -- [zBit\_RtpStartsWithFragment](AV1RtpPayload.md#zbit_rtpstartswithfragment) +[werift](../globals.md) / AV1RtpPayload -### Accessors - -- [isKeyframe](AV1RtpPayload.md#iskeyframe) - -### Methods - -- [deSerialize](AV1RtpPayload.md#deserialize) -- [getFrame](AV1RtpPayload.md#getframe) -- [isDetectedFinalPacketInSequence](AV1RtpPayload.md#isdetectedfinalpacketinsequence) +# Class: AV1RtpPayload ## Constructors -### constructor +### new AV1RtpPayload() -• **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md) +> **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md) #### Returns @@ -40,40 +20,40 @@ ### nBit\_RtpStartsNewCodedVideoSequence -• **nBit\_RtpStartsNewCodedVideoSequence**: `number` +> **nBit\_RtpStartsNewCodedVideoSequence**: `number` RtpStartsNewCodedVideoSequence MUST be set to 1 if the packet is the first packet of a coded video sequence, and MUST be set to 0 otherwise. -___ +*** ### obu\_or\_fragment -• **obu\_or\_fragment**: \{ `data`: `Buffer` ; `isFragment`: `boolean` }[] = `[]` +> **obu\_or\_fragment**: `object`[] = `[]` -___ +*** ### w\_RtpNumObus -• **w\_RtpNumObus**: `number` +> **w\_RtpNumObus**: `number` RtpNumObus two bit field that describes the number of OBU elements in the packet. This field MUST be set equal to 0 or equal to the number of OBU elements contained in the packet. If set to 0, each OBU element MUST be preceded by a length field. -___ +*** ### yBit\_RtpEndsWithFragment -• **yBit\_RtpEndsWithFragment**: `number` +> **yBit\_RtpEndsWithFragment**: `number` RtpEndsWithFragment MUST be set to 1 if the last OBU element is an OBU fragment that will continue in the next packet, and MUST be set to 0 otherwise. -___ +*** ### zBit\_RtpStartsWithFragment -• **zBit\_RtpStartsWithFragment**: `number` +> **zBit\_RtpStartsWithFragment**: `number` RtpStartsWithFragment MUST be set to 1 if the first OBU element is an OBU fragment that is a continuation of an OBU fragment from the previous packet, and MUST be set to 0 otherwise. @@ -82,7 +62,7 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -90,47 +70,41 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md) +> `static` **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`AV1RtpPayload`](AV1RtpPayload.md) -___ +*** -### getFrame +### getFrame() -▸ **getFrame**(`payloads`): `Buffer` +> `static` **getFrame**(`payloads`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `payloads` | [`AV1RtpPayload`](AV1RtpPayload.md)[] | +• **payloads**: [`AV1RtpPayload`](AV1RtpPayload.md)[] #### Returns `Buffer` -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/doc/classes/BitStream.md b/doc/classes/BitStream.md index 7fbf83a54..f7315380e 100644 --- a/doc/classes/BitStream.md +++ b/doc/classes/BitStream.md @@ -1,34 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / BitStream +[**werift**](../README.md) • **Docs** -# Class: BitStream - -## Table of contents - -### Constructors - -- [constructor](BitStream.md#constructor) - -### Properties - -- [uint8Array](BitStream.md#uint8array) +*** -### Methods +[werift](../globals.md) / BitStream -- [readBits](BitStream.md#readbits) -- [seekTo](BitStream.md#seekto) -- [writeBits](BitStream.md#writebits) +# Class: BitStream ## Constructors -### constructor +### new BitStream() -• **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md) +> **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `uint8Array` | `Buffer` | +• **uint8Array**: `Buffer` #### Returns @@ -38,53 +24,49 @@ ### uint8Array -• **uint8Array**: `Buffer` +> **uint8Array**: `Buffer` ## Methods -### readBits +### readBits() -▸ **readBits**(`bits`, `bitBuffer?`): `any` +> **readBits**(`bits`, `bitBuffer`?): `any` #### Parameters -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `bitBuffer?` | `number` | +• **bits**: `number` + +• **bitBuffer?**: `number` #### Returns `any` -___ +*** -### seekTo +### seekTo() -▸ **seekTo**(`bitPos`): `void` +> **seekTo**(`bitPos`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `bitPos` | `number` | +• **bitPos**: `number` #### Returns `void` -___ +*** -### writeBits +### writeBits() -▸ **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md) +> **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `value` | `number` | +• **bits**: `number` + +• **value**: `number` #### Returns diff --git a/doc/classes/BitWriter.md b/doc/classes/BitWriter.md index 075f64a68..2c1cf8aab 100644 --- a/doc/classes/BitWriter.md +++ b/doc/classes/BitWriter.md @@ -1,36 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / BitWriter +[**werift**](../README.md) • **Docs** -# Class: BitWriter - -## Table of contents - -### Constructors - -- [constructor](BitWriter.md#constructor) - -### Properties - -- [value](BitWriter.md#value) +*** -### Accessors +[werift](../globals.md) / BitWriter -- [buffer](BitWriter.md#buffer) - -### Methods - -- [set](BitWriter.md#set) +# Class: BitWriter ## Constructors -### constructor +### new BitWriter() -• **new BitWriter**(`bitLength`): [`BitWriter`](BitWriter.md) +> **new BitWriter**(`bitLength`): [`BitWriter`](BitWriter.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bitLength` | `number` | +• **bitLength**: `number` #### Returns @@ -40,13 +24,13 @@ ### value -• **value**: `number` = `0` +> **value**: `number` = `0` ## Accessors ### buffer -• `get` **buffer**(): `Buffer` +> `get` **buffer**(): `Buffer` #### Returns @@ -54,17 +38,17 @@ ## Methods -### set +### set() -▸ **set**(`size`, `startIndex`, `value`): [`BitWriter`](BitWriter.md) +> **set**(`size`, `startIndex`, `value`): [`BitWriter`](BitWriter.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | -| `startIndex` | `number` | -| `value` | `number` | +• **size**: `number` + +• **startIndex**: `number` + +• **value**: `number` #### Returns diff --git a/doc/classes/BitWriter2.md b/doc/classes/BitWriter2.md index abe8fc2d2..f2eae23c9 100644 --- a/doc/classes/BitWriter2.md +++ b/doc/classes/BitWriter2.md @@ -1,39 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / BitWriter2 +[**werift**](../README.md) • **Docs** -# Class: BitWriter2 - -## Table of contents - -### Constructors - -- [constructor](BitWriter2.md#constructor) - -### Properties - -- [offset](BitWriter2.md#offset) +*** -### Accessors +[werift](../globals.md) / BitWriter2 -- [buffer](BitWriter2.md#buffer) -- [value](BitWriter2.md#value) - -### Methods - -- [set](BitWriter2.md#set) +# Class: BitWriter2 ## Constructors -### constructor +### new BitWriter2() -• **new BitWriter2**(`bitLength`): [`BitWriter2`](BitWriter2.md) +> **new BitWriter2**(`bitLength`): [`BitWriter2`](BitWriter2.md) 各valueがオクテットを跨いではならない #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `bitLength` | `number` | Max 32bit | +• **bitLength**: `number` + +Max 32bit #### Returns @@ -43,23 +28,23 @@ ### offset -• **offset**: `bigint` +> **offset**: `bigint` ## Accessors ### buffer -• `get` **buffer**(): `Buffer` +> `get` **buffer**(): `Buffer` #### Returns `Buffer` -___ +*** ### value -• `get` **value**(): `number` +> `get` **value**(): `number` #### Returns @@ -67,16 +52,15 @@ ___ ## Methods -### set +### set() -▸ **set**(`value`, `size?`): [`BitWriter2`](BitWriter2.md) +> **set**(`value`, `size`): [`BitWriter2`](BitWriter2.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `value` | `number` | `undefined` | -| `size` | `number` | `1` | +• **value**: `number` + +• **size**: `number` = `1` #### Returns diff --git a/doc/classes/BufferChain.md b/doc/classes/BufferChain.md index d142a290b..e2685e29d 100644 --- a/doc/classes/BufferChain.md +++ b/doc/classes/BufferChain.md @@ -1,33 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / BufferChain +[**werift**](../README.md) • **Docs** -# Class: BufferChain - -## Table of contents - -### Constructors - -- [constructor](BufferChain.md#constructor) - -### Properties +*** -- [buffer](BufferChain.md#buffer) +[werift](../globals.md) / BufferChain -### Methods - -- [writeInt16BE](BufferChain.md#writeint16be) -- [writeUInt8](BufferChain.md#writeuint8) +# Class: BufferChain ## Constructors -### constructor +### new BufferChain() -• **new BufferChain**(`size`): [`BufferChain`](BufferChain.md) +> **new BufferChain**(`size`): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | +• **size**: `number` #### Returns @@ -37,37 +24,35 @@ ### buffer -• **buffer**: `Buffer` +> **buffer**: `Buffer` ## Methods -### writeInt16BE +### writeInt16BE() -▸ **writeInt16BE**(`value`, `offset?`): [`BufferChain`](BufferChain.md) +> **writeInt16BE**(`value`, `offset`?): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | `number` | -| `offset?` | `number` | +• **value**: `number` + +• **offset?**: `number` #### Returns [`BufferChain`](BufferChain.md) -___ +*** -### writeUInt8 +### writeUInt8() -▸ **writeUInt8**(`value`, `offset?`): [`BufferChain`](BufferChain.md) +> **writeUInt8**(`value`, `offset`?): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | `number` | -| `offset?` | `number` | +• **value**: `number` + +• **offset?**: `number` #### Returns diff --git a/doc/classes/Candidate.md b/doc/classes/Candidate.md index be2857ee4..a7c8f7931 100644 --- a/doc/classes/Candidate.md +++ b/doc/classes/Candidate.md @@ -1,54 +1,40 @@ -[werift](../README.md) / [Exports](../modules.md) / Candidate +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Candidate # Class: Candidate -## Table of contents +## Constructors -### Constructors +### new Candidate() -- [constructor](Candidate.md#constructor) +> **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress`?, `relatedPort`?, `tcptype`?, `generation`?): [`Candidate`](Candidate.md) -### Properties +#### Parameters -- [component](Candidate.md#component) -- [foundation](Candidate.md#foundation) -- [generation](Candidate.md#generation) -- [host](Candidate.md#host) -- [port](Candidate.md#port) -- [priority](Candidate.md#priority) -- [relatedAddress](Candidate.md#relatedaddress) -- [relatedPort](Candidate.md#relatedport) -- [tcptype](Candidate.md#tcptype) -- [transport](Candidate.md#transport) -- [type](Candidate.md#type) +• **foundation**: `string` -### Methods +• **component**: `number` -- [canPairWith](Candidate.md#canpairwith) -- [toSdp](Candidate.md#tosdp) -- [fromSdp](Candidate.md#fromsdp) +• **transport**: `string` -## Constructors +• **priority**: `number` -### constructor +• **host**: `string` -• **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress?`, `relatedPort?`, `tcptype?`, `generation?`): [`Candidate`](Candidate.md) +• **port**: `number` -#### Parameters +• **type**: `string` + +• **relatedAddress?**: `string` + +• **relatedPort?**: `number` -| Name | Type | -| :------ | :------ | -| `foundation` | `string` | -| `component` | `number` | -| `transport` | `string` | -| `priority` | `number` | -| `host` | `string` | -| `port` | `number` | -| `type` | `string` | -| `relatedAddress?` | `string` | -| `relatedPort?` | `number` | -| `tcptype?` | `string` | -| `generation?` | `number` | +• **tcptype?**: `string` + +• **generation?**: `number` #### Returns @@ -58,105 +44,101 @@ ### component -• **component**: `number` +> **component**: `number` -___ +*** ### foundation -• **foundation**: `string` +> **foundation**: `string` -___ +*** -### generation +### generation? -• `Optional` **generation**: `number` +> `optional` **generation**: `number` -___ +*** ### host -• **host**: `string` +> **host**: `string` -___ +*** ### port -• **port**: `number` +> **port**: `number` -___ +*** ### priority -• **priority**: `number` +> **priority**: `number` -___ +*** -### relatedAddress +### relatedAddress? -• `Optional` **relatedAddress**: `string` +> `optional` **relatedAddress**: `string` -___ +*** -### relatedPort +### relatedPort? -• `Optional` **relatedPort**: `number` +> `optional` **relatedPort**: `number` -___ +*** -### tcptype +### tcptype? -• `Optional` **tcptype**: `string` +> `optional` **tcptype**: `string` -___ +*** ### transport -• **transport**: `string` +> **transport**: `string` -___ +*** ### type -• **type**: `string` +> **type**: `string` ## Methods -### canPairWith +### canPairWith() -▸ **canPairWith**(`other`): `boolean` +> **canPairWith**(`other`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `other` | [`Candidate`](Candidate.md) | +• **other**: [`Candidate`](Candidate.md) #### Returns `boolean` -___ +*** -### toSdp +### toSdp() -▸ **toSdp**(): `string` +> **toSdp**(): `string` #### Returns `string` -___ +*** -### fromSdp +### fromSdp() -▸ **fromSdp**(`sdp`): [`Candidate`](Candidate.md) +> `static` **fromSdp**(`sdp`): [`Candidate`](Candidate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `sdp` | `string` | +• **sdp**: `string` #### Returns diff --git a/doc/classes/CandidatePair.md b/doc/classes/CandidatePair.md index 621e12721..f85a1b660 100644 --- a/doc/classes/CandidatePair.md +++ b/doc/classes/CandidatePair.md @@ -1,154 +1,144 @@ -[werift](../README.md) / [Exports](../modules.md) / CandidatePair +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CandidatePair # Class: CandidatePair -## Table of contents +## Constructors -### Constructors +### new CandidatePair() -- [constructor](CandidatePair.md#constructor) +> **new CandidatePair**(`protocol`, `remoteCandidate`): [`CandidatePair`](CandidatePair.md) -### Properties +#### Parameters -- [handle](CandidatePair.md#handle) -- [nominated](CandidatePair.md#nominated) -- [protocol](CandidatePair.md#protocol) -- [remoteCandidate](CandidatePair.md#remotecandidate) -- [remoteNominated](CandidatePair.md#remotenominated) +• **protocol**: [`Protocol`](../interfaces/Protocol.md) -### Accessors +• **remoteCandidate**: [`Candidate`](Candidate.md) -- [component](CandidatePair.md#component) -- [localCandidate](CandidatePair.md#localcandidate) -- [remoteAddr](CandidatePair.md#remoteaddr) -- [state](CandidatePair.md#state) +#### Returns -### Methods +[`CandidatePair`](CandidatePair.md) -- [toJSON](CandidatePair.md#tojson) -- [updateState](CandidatePair.md#updatestate) +## Properties -## Constructors +### handle? -### constructor +> `optional` **handle**: `object` -• **new CandidatePair**(`protocol`, `remoteCandidate`): [`CandidatePair`](CandidatePair.md) +#### cancel() -#### Parameters +> **cancel**: () => `void` -| Name | Type | -| :------ | :------ | -| `protocol` | [`Protocol`](../interfaces/Protocol.md) | -| `remoteCandidate` | [`Candidate`](Candidate.md) | +##### Returns -#### Returns +`void` -[`CandidatePair`](CandidatePair.md) +#### done() -## Properties +> **done**: () => `boolean` -### handle +##### Returns -• `Optional` **handle**: `Object` +`boolean` -#### Type declaration +#### promise -| Name | Type | -| :------ | :------ | -| `cancel` | () => `void` | -| `done` | () => `boolean` | -| `promise` | `PCancelable`\<`any`\> | +> **promise**: `PCancelable`\<`any`\> = `pCancel` -___ +*** ### nominated -• **nominated**: `boolean` = `false` +> **nominated**: `boolean` = `false` -___ +*** ### protocol -• **protocol**: [`Protocol`](../interfaces/Protocol.md) +> **protocol**: [`Protocol`](../interfaces/Protocol.md) -___ +*** ### remoteCandidate -• **remoteCandidate**: [`Candidate`](Candidate.md) +> **remoteCandidate**: [`Candidate`](Candidate.md) -___ +*** ### remoteNominated -• **remoteNominated**: `boolean` = `false` +> **remoteNominated**: `boolean` = `false` ## Accessors ### component -• `get` **component**(): `number` +> `get` **component**(): `number` #### Returns `number` -___ +*** ### localCandidate -• `get` **localCandidate**(): [`Candidate`](Candidate.md) +> `get` **localCandidate**(): [`Candidate`](Candidate.md) #### Returns [`Candidate`](Candidate.md) -___ +*** ### remoteAddr -• `get` **remoteAddr**(): readonly [`string`, `number`] +> `get` **remoteAddr**(): readonly [`string`, `number`] #### Returns readonly [`string`, `number`] -___ +*** ### state -• `get` **state**(): [`CandidatePairState`](../enums/CandidatePairState.md) +> `get` **state**(): [`CandidatePairState`](../enumerations/CandidatePairState.md) #### Returns -[`CandidatePairState`](../enums/CandidatePairState.md) +[`CandidatePairState`](../enumerations/CandidatePairState.md) ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### protocol + +> **protocol**: `string` + +##### remoteAddr -| Name | Type | -| :------ | :------ | -| `protocol` | `string` | -| `remoteAddr` | readonly [`string`, `number`] | +> **remoteAddr**: readonly [`string`, `number`] -___ +*** -### updateState +### updateState() -▸ **updateState**(`state`): `void` +> **updateState**(`state`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `state` | [`CandidatePairState`](../enums/CandidatePairState.md) | +• **state**: [`CandidatePairState`](../enumerations/CandidatePairState.md) #### Returns diff --git a/doc/classes/Connection.md b/doc/classes/Connection.md index b5511d9f4..12b721686 100644 --- a/doc/classes/Connection.md +++ b/doc/classes/Connection.md @@ -1,69 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / Connection +[**werift**](../README.md) • **Docs** -# Class: Connection +*** + +[werift](../globals.md) / Connection -## Table of contents - -### Constructors - -- [constructor](Connection.md#constructor) - -### Properties - -- [\_components](Connection.md#_components) -- [\_localCandidatesEnd](Connection.md#_localcandidatesend) -- [\_tieBreaker](Connection.md#_tiebreaker) -- [checkList](Connection.md#checklist) -- [dnsLookup](Connection.md#dnslookup) -- [iceControlling](Connection.md#icecontrolling) -- [localCandidates](Connection.md#localcandidates) -- [localPassword](Connection.md#localpassword) -- [localUserName](Connection.md#localusername) -- [onData](Connection.md#ondata) -- [options](Connection.md#options) -- [remoteCandidatesEnd](Connection.md#remotecandidatesend) -- [remoteIsLite](Connection.md#remoteislite) -- [remotePassword](Connection.md#remotepassword) -- [remoteUsername](Connection.md#remoteusername) -- [state](Connection.md#state) -- [stateChanged](Connection.md#statechanged) -- [stunServer](Connection.md#stunserver) -- [turnServer](Connection.md#turnserver) -- [useIpv4](Connection.md#useipv4) -- [useIpv6](Connection.md#useipv6) - -### Accessors - -- [nominatedKeys](Connection.md#nominatedkeys) -- [remoteCandidates](Connection.md#remotecandidates) - -### Methods - -- [addRemoteCandidate](Connection.md#addremotecandidate) -- [checkIncoming](Connection.md#checkincoming) -- [checkStart](Connection.md#checkstart) -- [close](Connection.md#close) -- [connect](Connection.md#connect) -- [dataReceived](Connection.md#datareceived) -- [gatherCandidates](Connection.md#gathercandidates) -- [getDefaultCandidate](Connection.md#getdefaultcandidate) -- [requestReceived](Connection.md#requestreceived) -- [resetNominatedPair](Connection.md#resetnominatedpair) -- [send](Connection.md#send) -- [setRemoteParams](Connection.md#setremoteparams) +# Class: Connection ## Constructors -### constructor +### new Connection() -• **new Connection**(`iceControlling`, `options?`): [`Connection`](Connection.md) +> **new Connection**(`iceControlling`, `options`?): [`Connection`](Connection.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `iceControlling` | `boolean` | -| `options?` | `Partial`\<[`IceOptions`](../interfaces/IceOptions.md)\> | +• **iceControlling**: `boolean` + +• **options?**: `Partial`\<[`IceOptions`](../interfaces/IceOptions.md)\> #### Returns @@ -71,345 +24,317 @@ ## Properties -### \_components - -• **\_components**: `Set`\<`number`\> - -コンポーネントはデータストリームの一部です. データストリームには複数のコンポーネントが必要な場合があり、 -データストリーム全体が機能するには、それぞれが機能する必要があります. - RTP / RTCPデータストリームの場合、RTPとRTCPが同じポートで多重化されていない限り、データストリームごとに2つのコンポーネントがあります. -1つはRTP用、もう1つはRTCP用です. コンポーネントには候補ペアがあり、他のコンポーネントでは使用できません. - -___ - ### \_localCandidatesEnd -• **\_localCandidatesEnd**: `boolean` = `false` +> **\_localCandidatesEnd**: `boolean` = `false` -___ +*** ### \_tieBreaker -• **\_tieBreaker**: `BigInt` +> **\_tieBreaker**: `bigint` -___ +*** ### checkList -• **checkList**: [`CandidatePair`](CandidatePair.md)[] = `[]` - -___ - -### dnsLookup - -• `Optional` **dnsLookup**: `DnsLookup` +> **checkList**: [`CandidatePair`](CandidatePair.md)[] = `[]` -___ +*** ### iceControlling -• **iceControlling**: `boolean` +> **iceControlling**: `boolean` -___ +*** ### localCandidates -• **localCandidates**: [`Candidate`](Candidate.md)[] = `[]` +> **localCandidates**: [`Candidate`](Candidate.md)[] = `[]` -___ +*** ### localPassword -• **localPassword**: `string` +> **localPassword**: `string` -___ +*** ### localUserName -• **localUserName**: `string` +> **localUserName**: `string` + +*** + +### lookup? + +> `optional` **lookup**: `MdnsLookup` + +*** + +### nominated? -___ +> `optional` **nominated**: [`CandidatePair`](CandidatePair.md) + +*** ### onData -• `Readonly` **onData**: `Event`\<[`Buffer`, `number`]\> +> `readonly` **onData**: [`Event`](Event.md)\<[`Buffer`, `number`]\> -___ +*** ### options -• **options**: [`IceOptions`](../interfaces/IceOptions.md) +> **options**: [`IceOptions`](../interfaces/IceOptions.md) -___ +*** ### remoteCandidatesEnd -• **remoteCandidatesEnd**: `boolean` = `false` +> **remoteCandidatesEnd**: `boolean` = `false` -___ +*** ### remoteIsLite -• **remoteIsLite**: `boolean` = `false` +> **remoteIsLite**: `boolean` = `false` -___ +*** ### remotePassword -• **remotePassword**: `string` = `""` +> **remotePassword**: `string` = `""` -___ +*** ### remoteUsername -• **remoteUsername**: `string` = `""` +> **remoteUsername**: `string` = `""` + +*** + +### restarted -___ +> **restarted**: `boolean` = `false` + +*** ### state -• **state**: `IceState` = `"new"` +> **state**: `IceState` = `"new"` -___ +*** ### stateChanged -• `Readonly` **stateChanged**: `Event`\<[`IceState`]\> +> `readonly` **stateChanged**: [`Event`](Event.md)\<[`IceState`]\> -___ +*** -### stunServer +### stunServer? -• `Optional` **stunServer**: readonly [`string`, `number`] +> `optional` **stunServer**: readonly [`string`, `number`] -___ +*** -### turnServer +### turnServer? -• `Optional` **turnServer**: readonly [`string`, `number`] +> `optional` **turnServer**: readonly [`string`, `number`] -___ +*** ### useIpv4 -• **useIpv4**: `boolean` +> **useIpv4**: `boolean` -___ +*** ### useIpv6 -• **useIpv6**: `boolean` +> **useIpv6**: `boolean` ## Accessors -### nominatedKeys - -• `get` **nominatedKeys**(): `string`[] - -#### Returns - -`string`[] - -___ - ### remoteCandidates -• `get` **remoteCandidates**(): [`Candidate`](Candidate.md)[] - -#### Returns - -[`Candidate`](Candidate.md)[] +> `get` **remoteCandidates**(): [`Candidate`](Candidate.md)[] -• `set` **remoteCandidates**(`value`): `void` +> `set` **remoteCandidates**(`value`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | [`Candidate`](Candidate.md)[] | +• **value**: [`Candidate`](Candidate.md)[] #### Returns -`void` +[`Candidate`](Candidate.md)[] ## Methods -### addRemoteCandidate +### addRemoteCandidate() -▸ **addRemoteCandidate**(`remoteCandidate`): `Promise`\<`void`\> +> **addRemoteCandidate**(`remoteCandidate`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `remoteCandidate` | `undefined` \| [`Candidate`](Candidate.md) | +• **remoteCandidate**: `undefined` \| [`Candidate`](Candidate.md) #### Returns `Promise`\<`void`\> -___ +*** -### checkIncoming +### checkIncoming() -▸ **checkIncoming**(`message`, `addr`, `protocol`): `void` +> **checkIncoming**(`message`, `addr`, `protocol`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `message` | `Message` | -| `addr` | readonly [`string`, `number`] | -| `protocol` | [`Protocol`](../interfaces/Protocol.md) | +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) #### Returns `void` -___ +*** -### checkStart +### checkStart() -▸ **checkStart**(`pair`): `PCancelable`\<`unknown`\> +> **checkStart**(`pair`): `PCancelable`\<`unknown`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `pair` | [`CandidatePair`](CandidatePair.md) | +• **pair**: [`CandidatePair`](CandidatePair.md) #### Returns `PCancelable`\<`unknown`\> -___ +*** -### close +### close() -▸ **close**(): `Promise`\<`void`\> +> **close**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### connect +### connect() -▸ **connect**(): `Promise`\<`void`\> +> **connect**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### dataReceived +### dataReceived() -▸ **dataReceived**(`data`, `component`): `void` +> **dataReceived**(`data`, `component`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `component` | `number` | +• **data**: `Buffer` + +• **component**: `number` #### Returns `void` -___ +*** -### gatherCandidates +### gatherCandidates() -▸ **gatherCandidates**(`cb?`): `Promise`\<`void`\> +> **gatherCandidates**(`cb`?): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `cb?` | (`candidate`: [`Candidate`](Candidate.md)) => `void` | +• **cb?** #### Returns `Promise`\<`void`\> -___ - -### getDefaultCandidate +*** -▸ **getDefaultCandidate**(`component`): `undefined` \| [`Candidate`](Candidate.md) +### getDefaultCandidate() -#### Parameters - -| Name | Type | -| :------ | :------ | -| `component` | `number` | +> **getDefaultCandidate**(): [`Candidate`](Candidate.md) #### Returns -`undefined` \| [`Candidate`](Candidate.md) +[`Candidate`](Candidate.md) -___ +*** -### requestReceived +### requestReceived() -▸ **requestReceived**(`message`, `addr`, `protocol`, `rawData`): `void` +> **requestReceived**(`message`, `addr`, `protocol`, `rawData`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `message` | `Message` | -| `addr` | readonly [`string`, `number`] | -| `protocol` | [`Protocol`](../interfaces/Protocol.md) | -| `rawData` | `Buffer` | +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +• **rawData**: `Buffer` #### Returns `void` -___ +*** -### resetNominatedPair +### resetNominatedPair() -▸ **resetNominatedPair**(): `void` +> **resetNominatedPair**(): `void` #### Returns `void` -___ +*** -### send +### send() -▸ **send**(`data`): `Promise`\<`void`\> +> **send**(`data`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns `Promise`\<`void`\> -___ +*** -### setRemoteParams +### setRemoteParams() -▸ **setRemoteParams**(`«destructured»`): `void` +> **setRemoteParams**(`__namedParameters`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `iceLite` | `boolean` | -| › `password` | `string` | -| › `usernameFragment` | `string` | +• **\_\_namedParameters** + +• **\_\_namedParameters.iceLite**: `boolean` + +• **\_\_namedParameters.password**: `string` + +• **\_\_namedParameters.usernameFragment**: `string` #### Returns diff --git a/doc/classes/DePacketizerBase.md b/doc/classes/DePacketizerBase.md index 94e6594be..01995661b 100644 --- a/doc/classes/DePacketizerBase.md +++ b/doc/classes/DePacketizerBase.md @@ -1,39 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / DePacketizerBase +[**werift**](../README.md) • **Docs** -# Class: DePacketizerBase +*** -## Implemented by +[werift](../globals.md) / DePacketizerBase -- [`H264RtpPayload`](H264RtpPayload.md) -- [`OpusRtpPayload`](OpusRtpPayload.md) -- [`Vp8RtpPayload`](Vp8RtpPayload.md) -- [`Vp9RtpPayload`](Vp9RtpPayload.md) - -## Table of contents - -### Constructors - -- [constructor](DePacketizerBase.md#constructor) - -### Properties - -- [fragment](DePacketizerBase.md#fragment) -- [payload](DePacketizerBase.md#payload) - -### Accessors - -- [isKeyframe](DePacketizerBase.md#iskeyframe) - -### Methods - -- [deSerialize](DePacketizerBase.md#deserialize) -- [isDetectedFinalPacketInSequence](DePacketizerBase.md#isdetectedfinalpacketinsequence) +# Class: `abstract` DePacketizerBase ## Constructors -### constructor +### new DePacketizerBase() -• **new DePacketizerBase**(): [`DePacketizerBase`](DePacketizerBase.md) +> **new DePacketizerBase**(): [`DePacketizerBase`](DePacketizerBase.md) #### Returns @@ -41,21 +18,21 @@ ## Properties -### fragment +### fragment? -• `Optional` **fragment**: `Buffer` +> `optional` **fragment**: `Buffer` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -63,32 +40,29 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`, `fragment?`): [`DePacketizerBase`](DePacketizerBase.md) +> `static` **deSerialize**(`buf`, `fragment`?): [`DePacketizerBase`](DePacketizerBase.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `fragment?` | `Buffer` | +• **buf**: `Buffer` + +• **fragment?**: `Buffer` #### Returns [`DePacketizerBase`](DePacketizerBase.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/doc/classes/Event.md b/doc/classes/Event.md new file mode 100644 index 000000000..8b723c698 --- /dev/null +++ b/doc/classes/Event.md @@ -0,0 +1,349 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Event + +# Class: Event\ + +## Type Parameters + +• **T** *extends* `any`[] + +## Constructors + +### new Event() + +> **new Event**\<`T`\>(): [`Event`](Event.md)\<`T`\> + +#### Returns + +[`Event`](Event.md)\<`T`\> + +## Properties + +### ended + +> **ended**: `boolean` = `false` + +*** + +### onended()? + +> `optional` **onended**: () => `void` + +#### Returns + +`void` + +## Accessors + +### length + +> `get` **length**(): `number` + +#### Returns + +`number` + +*** + +### returnListener + +> `get` **returnListener**(): `object` + +#### Returns + +`object` + +##### asPromise() + +> **asPromise**: (`timeLimit`?) => `Promise`\<`T`\> + +###### Parameters + +• **timeLimit?**: `number` + +###### Returns + +`Promise`\<`T`\> + +##### once() + +> **once**: (`execute`, `complete`?, `error`?) => `void` + +###### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +###### Returns + +`void` + +##### subscribe() + +> **subscribe**: (`execute`, `complete`?, `error`?) => `object` + +###### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +###### Returns + +`object` + +###### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +###### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### returnTrigger + +> `get` **returnTrigger**(): `object` + +#### Returns + +`object` + +##### complete() + +> **complete**: () => `void` + +###### Returns + +`void` + +##### error() + +> **error**: (`e`) => `void` + +###### Parameters + +• **e**: `any` + +###### Returns + +`void` + +##### execute() + +> **execute**: (...`args`) => `void` + +###### Parameters + +• ...**args**: `T` + +###### Returns + +`void` + +## Methods + +### allUnsubscribe() + +> **allUnsubscribe**(): `void` + +#### Returns + +`void` + +*** + +### asPromise() + +> **asPromise**(`timeLimit`?): `Promise`\<`T`\> + +#### Parameters + +• **timeLimit?**: `number` + +#### Returns + +`Promise`\<`T`\> + +*** + +### complete() + +> **complete**(): `void` + +#### Returns + +`void` + +*** + +### error() + +> **error**(`e`): `void` + +#### Parameters + +• **e**: `any` + +#### Returns + +`void` + +*** + +### execute() + +> **execute**(...`args`): `void` + +#### Parameters + +• ...**args**: `T` + +#### Returns + +`void` + +*** + +### once() + +> **once**(`execute`, `complete`?, `error`?): `void` + +#### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`void` + +*** + +### onerror() + +> **onerror**(`e`): `void` + +#### Parameters + +• **e**: `any` + +#### Returns + +`void` + +*** + +### queuingSubscribe() + +> **queuingSubscribe**(`execute`, `complete`?, `error`?): `object` + +#### Parameters + +• **execute**: `PromiseEventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`object` + +##### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +##### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### subscribe() + +> **subscribe**(`execute`, `complete`?, `error`?): `object` + +#### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`object` + +##### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +##### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### watch() + +> **watch**(`cb`, `timeLimit`?): `Promise`\<`T`\> + +#### Parameters + +• **cb** + +• **timeLimit?**: `number` + +#### Returns + +`Promise`\<`T`\> diff --git a/doc/classes/EventDisposer.md b/doc/classes/EventDisposer.md new file mode 100644 index 000000000..d0b28fc61 --- /dev/null +++ b/doc/classes/EventDisposer.md @@ -0,0 +1,41 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / EventDisposer + +# Class: EventDisposer + +## Constructors + +### new EventDisposer() + +> **new EventDisposer**(): [`EventDisposer`](EventDisposer.md) + +#### Returns + +[`EventDisposer`](EventDisposer.md) + +## Methods + +### dispose() + +> **dispose**(): `void` + +#### Returns + +`void` + +*** + +### push() + +> **push**(`disposer`): `void` + +#### Parameters + +• **disposer** + +#### Returns + +`void` diff --git a/doc/classes/GenericNack.md b/doc/classes/GenericNack.md index d06cb0846..beb123041 100644 --- a/doc/classes/GenericNack.md +++ b/doc/classes/GenericNack.md @@ -1,39 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / GenericNack +[**werift**](../README.md) • **Docs** -# Class: GenericNack - -## Table of contents - -### Constructors - -- [constructor](GenericNack.md#constructor) +*** -### Properties +[werift](../globals.md) / GenericNack -- [count](GenericNack.md#count) -- [header](GenericNack.md#header) -- [lost](GenericNack.md#lost) -- [mediaSourceSsrc](GenericNack.md#mediasourcessrc) -- [senderSsrc](GenericNack.md#senderssrc) -- [count](GenericNack.md#count-1) - -### Methods - -- [serialize](GenericNack.md#serialize) -- [toJSON](GenericNack.md#tojson) -- [deSerialize](GenericNack.md#deserialize) +# Class: GenericNack ## Constructors -### constructor +### new GenericNack() -• **new GenericNack**(`props?`): [`GenericNack`](GenericNack.md) +> **new GenericNack**(`props`): [`GenericNack`](GenericNack.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`GenericNack`](GenericNack.md)\> | +• **props**: `Partial`\<[`GenericNack`](GenericNack.md)\> = `{}` #### Returns @@ -43,76 +24,81 @@ ### count -• `Readonly` **count**: `number` = `GenericNack.count` +> `readonly` **count**: `number` = `GenericNack.count` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### lost -• **lost**: `number`[] = `[]` +> **lost**: `number`[] = `[]` -___ +*** ### mediaSourceSsrc -• **mediaSourceSsrc**: `number` +> **mediaSourceSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `1` +> `static` **count**: `number` = `1` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` -| Name | Type | -| :------ | :------ | -| `lost` | `number`[] | -| `mediaSourceSsrc` | `number` | -| `senderSsrc` | `number` | +##### lost -___ +> **lost**: `number`[] -### deSerialize +##### mediaSourceSsrc -▸ **deSerialize**(`data`, `header`): [`GenericNack`](GenericNack.md) +> **mediaSourceSsrc**: `number` + +##### senderSsrc + +> **senderSsrc**: `number` + +*** + +### deSerialize() + +> `static` **deSerialize**(`data`, `header`): [`GenericNack`](GenericNack.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/doc/classes/GroupDescription.md b/doc/classes/GroupDescription.md index 1d941f799..85bde633f 100644 --- a/doc/classes/GroupDescription.md +++ b/doc/classes/GroupDescription.md @@ -1,34 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / GroupDescription +[**werift**](../README.md) • **Docs** -# Class: GroupDescription - -## Table of contents - -### Constructors - -- [constructor](GroupDescription.md#constructor) - -### Properties - -- [items](GroupDescription.md#items) -- [semantic](GroupDescription.md#semantic) +*** -### Accessors +[werift](../globals.md) / GroupDescription -- [str](GroupDescription.md#str) +# Class: GroupDescription ## Constructors -### constructor +### new GroupDescription() -• **new GroupDescription**(`semantic`, `items`): [`GroupDescription`](GroupDescription.md) +> **new GroupDescription**(`semantic`, `items`): [`GroupDescription`](GroupDescription.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `semantic` | `string` | -| `items` | `string`[] | +• **semantic**: `string` + +• **items**: `string`[] #### Returns @@ -38,19 +26,19 @@ ### items -• **items**: `string`[] +> **items**: `string`[] -___ +*** ### semantic -• **semantic**: `string` +> **semantic**: `string` ## Accessors ### str -• `get` **str**(): `string` +> `get` **str**(): `string` #### Returns diff --git a/doc/classes/H264RtpPayload.md b/doc/classes/H264RtpPayload.md index baa3fc643..e8a2e9d5b 100644 --- a/doc/classes/H264RtpPayload.md +++ b/doc/classes/H264RtpPayload.md @@ -1,4 +1,8 @@ -[werift](../README.md) / [Exports](../modules.md) / H264RtpPayload +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / H264RtpPayload # Class: H264RtpPayload @@ -6,39 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](H264RtpPayload.md#constructor) - -### Properties - -- [e](H264RtpPayload.md#e) -- [f](H264RtpPayload.md#f) -- [fragment](H264RtpPayload.md#fragment) -- [nalUnitPayloadType](H264RtpPayload.md#nalunitpayloadtype) -- [nalUnitType](H264RtpPayload.md#nalunittype) -- [nri](H264RtpPayload.md#nri) -- [payload](H264RtpPayload.md#payload) -- [r](H264RtpPayload.md#r) -- [s](H264RtpPayload.md#s) - -### Accessors - -- [isKeyframe](H264RtpPayload.md#iskeyframe) -- [isPartitionHead](H264RtpPayload.md#ispartitionhead) - -### Methods - -- [deSerialize](H264RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](H264RtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new H264RtpPayload() -• **new H264RtpPayload**(): [`H264RtpPayload`](H264RtpPayload.md) +> **new H264RtpPayload**(): [`H264RtpPayload`](H264RtpPayload.md) #### Returns @@ -48,71 +24,71 @@ ### e -• **e**: `number` +> **e**: `number` end of a fragmented NAL unit -___ +*** ### f -• **f**: `number` +> **f**: `number` forbidden_zero_bit -___ +*** -### fragment +### fragment? -• `Optional` **fragment**: `Buffer` +> `optional` **fragment**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[fragment](DePacketizerBase.md#fragment) +[`DePacketizerBase`](DePacketizerBase.md).[`fragment`](DePacketizerBase.md#fragment) -___ +*** ### nalUnitPayloadType -• **nalUnitPayloadType**: `number` +> **nalUnitPayloadType**: `number` -___ +*** ### nalUnitType -• **nalUnitType**: `number` +> **nalUnitType**: `number` nal_unit_types -___ +*** ### nri -• **nri**: `number` +> **nri**: `number` nal_ref_idc -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** ### r -• **r**: `number` +> **r**: `number` -___ +*** ### s -• **s**: `number` +> **s**: `number` start of a fragmented NAL unit @@ -120,7 +96,7 @@ start of a fragmented NAL unit ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -128,13 +104,13 @@ start of a fragmented NAL unit #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` +> `get` **isPartitionHead**(): `boolean` #### Returns @@ -142,32 +118,29 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`, `fragment?`): [`H264RtpPayload`](H264RtpPayload.md) +> `static` **deSerialize**(`buf`, `fragment`?): [`H264RtpPayload`](H264RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `fragment?` | `Buffer` | +• **buf**: `Buffer` + +• **fragment?**: `Buffer` #### Returns [`H264RtpPayload`](H264RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/doc/classes/IceCandidate.md b/doc/classes/IceCandidate.md index 30e959eb7..3847f175f 100644 --- a/doc/classes/IceCandidate.md +++ b/doc/classes/IceCandidate.md @@ -1,50 +1,32 @@ -[werift](../README.md) / [Exports](../modules.md) / IceCandidate +[**werift**](../README.md) • **Docs** -# Class: IceCandidate +*** -## Table of contents +[werift](../globals.md) / IceCandidate -### Constructors +# Class: IceCandidate -- [constructor](IceCandidate.md#constructor) +## Constructors -### Properties +### new IceCandidate() -- [component](IceCandidate.md#component) -- [foundation](IceCandidate.md#foundation) -- [ip](IceCandidate.md#ip) -- [port](IceCandidate.md#port) -- [priority](IceCandidate.md#priority) -- [protocol](IceCandidate.md#protocol) -- [relatedAddress](IceCandidate.md#relatedaddress) -- [relatedPort](IceCandidate.md#relatedport) -- [sdpMLineIndex](IceCandidate.md#sdpmlineindex) -- [sdpMid](IceCandidate.md#sdpmid) -- [tcpType](IceCandidate.md#tcptype) -- [type](IceCandidate.md#type) +> **new IceCandidate**(`component`, `foundation`, `ip`, `port`, `priority`, `protocol`, `type`): [`IceCandidate`](IceCandidate.md) -### Methods +#### Parameters -- [toJSON](IceCandidate.md#tojson) -- [fromJSON](IceCandidate.md#fromjson) +• **component**: `number` -## Constructors +• **foundation**: `string` -### constructor +• **ip**: `string` -• **new IceCandidate**(`component`, `foundation`, `ip`, `port`, `priority`, `protocol`, `type`): [`IceCandidate`](IceCandidate.md) +• **port**: `number` -#### Parameters +• **priority**: `number` -| Name | Type | -| :------ | :------ | -| `component` | `number` | -| `foundation` | `string` | -| `ip` | `string` | -| `port` | `number` | -| `priority` | `number` | -| `protocol` | `string` | -| `type` | `string` | +• **protocol**: `string` + +• **type**: `string` #### Returns @@ -54,95 +36,93 @@ ### component -• **component**: `number` +> **component**: `number` -___ +*** ### foundation -• **foundation**: `string` +> **foundation**: `string` -___ +*** ### ip -• **ip**: `string` +> **ip**: `string` -___ +*** ### port -• **port**: `number` +> **port**: `number` -___ +*** ### priority -• **priority**: `number` +> **priority**: `number` -___ +*** ### protocol -• **protocol**: `string` +> **protocol**: `string` -___ +*** -### relatedAddress +### relatedAddress? -• `Optional` **relatedAddress**: `string` +> `optional` **relatedAddress**: `string` -___ +*** -### relatedPort +### relatedPort? -• `Optional` **relatedPort**: `number` +> `optional` **relatedPort**: `number` -___ +*** -### sdpMLineIndex +### sdpMLineIndex? -• `Optional` **sdpMLineIndex**: `number` +> `optional` **sdpMLineIndex**: `number` -___ +*** -### sdpMid +### sdpMid? -• `Optional` **sdpMid**: `string` +> `optional` **sdpMid**: `string` -___ +*** -### tcpType +### tcpType? -• `Optional` **tcpType**: `string` +> `optional` **tcpType**: `string` -___ +*** ### type -• **type**: `string` +> **type**: `string` ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): [`RTCIceCandidate`](RTCIceCandidate.md) +> **toJSON**(): [`RTCIceCandidate`](RTCIceCandidate.md) #### Returns [`RTCIceCandidate`](RTCIceCandidate.md) -___ +*** -### fromJSON +### fromJSON() -▸ **fromJSON**(`data`): `undefined` \| [`IceCandidate`](IceCandidate.md) +> `static` **fromJSON**(`data`): `undefined` \| [`IceCandidate`](IceCandidate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | [`RTCIceCandidate`](RTCIceCandidate.md) | +• **data**: [`RTCIceCandidate`](RTCIceCandidate.md) #### Returns diff --git a/doc/classes/MediaDescription.md b/doc/classes/MediaDescription.md index 0cc629893..dd55c82df 100644 --- a/doc/classes/MediaDescription.md +++ b/doc/classes/MediaDescription.md @@ -1,56 +1,26 @@ -[werift](../README.md) / [Exports](../modules.md) / MediaDescription +[**werift**](../README.md) • **Docs** -# Class: MediaDescription +*** + +[werift](../globals.md) / MediaDescription -## Table of contents - -### Constructors - -- [constructor](MediaDescription.md#constructor) - -### Properties - -- [direction](MediaDescription.md#direction) -- [dtlsParams](MediaDescription.md#dtlsparams) -- [fmt](MediaDescription.md#fmt) -- [host](MediaDescription.md#host) -- [iceCandidates](MediaDescription.md#icecandidates) -- [iceCandidatesComplete](MediaDescription.md#icecandidatescomplete) -- [iceOptions](MediaDescription.md#iceoptions) -- [iceParams](MediaDescription.md#iceparams) -- [kind](MediaDescription.md#kind) -- [msid](MediaDescription.md#msid) -- [port](MediaDescription.md#port) -- [profile](MediaDescription.md#profile) -- [rtcpHost](MediaDescription.md#rtcphost) -- [rtcpMux](MediaDescription.md#rtcpmux) -- [rtcpPort](MediaDescription.md#rtcpport) -- [rtp](MediaDescription.md#rtp) -- [sctpCapabilities](MediaDescription.md#sctpcapabilities) -- [sctpMap](MediaDescription.md#sctpmap) -- [sctpPort](MediaDescription.md#sctpport) -- [simulcastParameters](MediaDescription.md#simulcastparameters) -- [ssrc](MediaDescription.md#ssrc) -- [ssrcGroup](MediaDescription.md#ssrcgroup) - -### Methods - -- [toString](MediaDescription.md#tostring) +# Class: MediaDescription ## Constructors -### constructor +### new MediaDescription() -• **new MediaDescription**(`kind`, `port`, `profile`, `fmt`): [`MediaDescription`](MediaDescription.md) +> **new MediaDescription**(`kind`, `port`, `profile`, `fmt`): [`MediaDescription`](MediaDescription.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `kind` | [`Kind`](../modules.md#kind) | -| `port` | `number` | -| `profile` | `string` | -| `fmt` | `number`[] \| `string`[] | +• **kind**: [`Kind`](../type-aliases/Kind.md) + +• **port**: `number` + +• **profile**: `string` + +• **fmt**: `number`[] \| `string`[] #### Returns @@ -58,145 +28,145 @@ ## Properties -### direction +### direction? -• `Optional` **direction**: ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +> `optional` **direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -___ +*** -### dtlsParams +### dtlsParams? -• `Optional` **dtlsParams**: [`RTCDtlsParameters`](RTCDtlsParameters.md) +> `optional` **dtlsParams**: [`RTCDtlsParameters`](RTCDtlsParameters.md) -___ +*** ### fmt -• **fmt**: `number`[] \| `string`[] +> **fmt**: `number`[] \| `string`[] -___ +*** -### host +### host? -• `Optional` **host**: `string` +> `optional` **host**: `string` -___ +*** ### iceCandidates -• **iceCandidates**: [`IceCandidate`](IceCandidate.md)[] = `[]` +> **iceCandidates**: [`IceCandidate`](IceCandidate.md)[] = `[]` -___ +*** ### iceCandidatesComplete -• **iceCandidatesComplete**: `boolean` = `false` +> **iceCandidatesComplete**: `boolean` = `false` -___ +*** -### iceOptions +### iceOptions? -• `Optional` **iceOptions**: `string` +> `optional` **iceOptions**: `string` -___ +*** -### iceParams +### iceParams? -• `Optional` **iceParams**: [`RTCIceParameters`](RTCIceParameters.md) +> `optional` **iceParams**: [`RTCIceParameters`](RTCIceParameters.md) -___ +*** ### kind -• **kind**: [`Kind`](../modules.md#kind) +> **kind**: [`Kind`](../type-aliases/Kind.md) -___ +*** -### msid +### msid? -• `Optional` **msid**: `string` +> `optional` **msid**: `string` -___ +*** ### port -• **port**: `number` +> **port**: `number` -___ +*** ### profile -• **profile**: `string` +> **profile**: `string` -___ +*** -### rtcpHost +### rtcpHost? -• `Optional` **rtcpHost**: `string` +> `optional` **rtcpHost**: `string` -___ +*** ### rtcpMux -• **rtcpMux**: `boolean` = `false` +> **rtcpMux**: `boolean` = `false` -___ +*** -### rtcpPort +### rtcpPort? -• `Optional` **rtcpPort**: `number` +> `optional` **rtcpPort**: `number` -___ +*** ### rtp -• **rtp**: [`RTCRtpParameters`](../interfaces/RTCRtpParameters.md) +> **rtp**: [`RTCRtpParameters`](../interfaces/RTCRtpParameters.md) -___ +*** -### sctpCapabilities +### sctpCapabilities? -• `Optional` **sctpCapabilities**: [`RTCSctpCapabilities`](RTCSctpCapabilities.md) +> `optional` **sctpCapabilities**: [`RTCSctpCapabilities`](RTCSctpCapabilities.md) -___ +*** ### sctpMap -• **sctpMap**: `Object` = `{}` +> **sctpMap**: `object` = `{}` -#### Index signature +#### Index Signature -▪ [key: `number`]: `string` + \[`key`: `number`\]: `string` -___ +*** -### sctpPort +### sctpPort? -• `Optional` **sctpPort**: `number` +> `optional` **sctpPort**: `number` -___ +*** ### simulcastParameters -• **simulcastParameters**: [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md)[] = `[]` +> **simulcastParameters**: [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md)[] = `[]` -___ +*** ### ssrc -• **ssrc**: [`SsrcDescription`](SsrcDescription.md)[] = `[]` +> **ssrc**: [`SsrcDescription`](SsrcDescription.md)[] = `[]` -___ +*** ### ssrcGroup -• **ssrcGroup**: [`GroupDescription`](GroupDescription.md)[] = `[]` +> **ssrcGroup**: [`GroupDescription`](GroupDescription.md)[] = `[]` ## Methods -### toString +### toString() -▸ **toString**(): `string` +> **toString**(): `string` #### Returns diff --git a/doc/classes/MediaStream.md b/doc/classes/MediaStream.md index 95e627fe6..18e0a714f 100644 --- a/doc/classes/MediaStream.md +++ b/doc/classes/MediaStream.md @@ -1,34 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / MediaStream +[**werift**](../README.md) • **Docs** -# Class: MediaStream - -## Table of contents - -### Constructors - -- [constructor](MediaStream.md#constructor) - -### Properties - -- [id](MediaStream.md#id) -- [tracks](MediaStream.md#tracks) +*** -### Methods +[werift](../globals.md) / MediaStream -- [addTrack](MediaStream.md#addtrack) -- [getTracks](MediaStream.md#gettracks) +# Class: MediaStream ## Constructors -### constructor +### new MediaStream() -• **new MediaStream**(`props`): [`MediaStream`](MediaStream.md) +> **new MediaStream**(`props`): [`MediaStream`](MediaStream.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`MediaStream`](MediaStream.md)\> & `Pick`\<[`MediaStream`](MediaStream.md), ``"id"``\> | +• **props**: [`MediaStreamTrack`](MediaStreamTrack.md)[] \| `Partial`\<[`MediaStream`](MediaStream.md)\> #### Returns @@ -38,35 +24,53 @@ ### id -• **id**: `string` +> **id**: `string` -___ +*** ### tracks -• **tracks**: [`MediaStreamTrack`](MediaStreamTrack.md)[] = `[]` +> **tracks**: [`MediaStreamTrack`](MediaStreamTrack.md)[] = `[]` ## Methods -### addTrack +### addTrack() -▸ **addTrack**(`track`): `void` +> **addTrack**(`track`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `track` | [`MediaStreamTrack`](MediaStreamTrack.md) | +• **track**: [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns `void` -___ +*** + +### getAudioTracks() + +> **getAudioTracks**(): [`MediaStreamTrack`](MediaStreamTrack.md)[] + +#### Returns + +[`MediaStreamTrack`](MediaStreamTrack.md)[] + +*** + +### getTracks() + +> **getTracks**(): [`MediaStreamTrack`](MediaStreamTrack.md)[] + +#### Returns + +[`MediaStreamTrack`](MediaStreamTrack.md)[] + +*** -### getTracks +### getVideoTracks() -▸ **getTracks**(): [`MediaStreamTrack`](MediaStreamTrack.md)[] +> **getVideoTracks**(): [`MediaStreamTrack`](MediaStreamTrack.md)[] #### Returns diff --git a/doc/classes/MediaStreamTrack.md b/doc/classes/MediaStreamTrack.md index 4c61c43bd..da15661ad 100644 --- a/doc/classes/MediaStreamTrack.md +++ b/doc/classes/MediaStreamTrack.md @@ -1,83 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / MediaStreamTrack +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / MediaStreamTrack # Class: MediaStreamTrack -## Hierarchy +## Extends - `EventTarget` - ↳ **`MediaStreamTrack`** - -## Table of contents - -### Constructors - -- [constructor](MediaStreamTrack.md#constructor) - -### Properties - -- [codec](MediaStreamTrack.md#codec) -- [enabled](MediaStreamTrack.md#enabled) -- [header](MediaStreamTrack.md#header) -- [id](MediaStreamTrack.md#id) -- [kind](MediaStreamTrack.md#kind) -- [label](MediaStreamTrack.md#label) -- [muted](MediaStreamTrack.md#muted) -- [onReceiveRtcp](MediaStreamTrack.md#onreceivertcp) -- [onReceiveRtp](MediaStreamTrack.md#onreceivertp) -- [onSourceChanged](MediaStreamTrack.md#onsourcechanged) -- [remote](MediaStreamTrack.md#remote) -- [rid](MediaStreamTrack.md#rid) -- [ssrc](MediaStreamTrack.md#ssrc) -- [stopped](MediaStreamTrack.md#stopped) -- [streamId](MediaStreamTrack.md#streamid) -- [uuid](MediaStreamTrack.md#uuid) -- [captureRejectionSymbol](MediaStreamTrack.md#capturerejectionsymbol) -- [captureRejections](MediaStreamTrack.md#capturerejections) -- [defaultMaxListeners](MediaStreamTrack.md#defaultmaxlisteners) -- [errorMonitor](MediaStreamTrack.md#errormonitor) - -### Methods - -- [[captureRejectionSymbol]](MediaStreamTrack.md#[capturerejectionsymbol]) -- [addEventListener](MediaStreamTrack.md#addeventlistener) -- [addListener](MediaStreamTrack.md#addlistener) -- [emit](MediaStreamTrack.md#emit) -- [eventNames](MediaStreamTrack.md#eventnames) -- [getMaxListeners](MediaStreamTrack.md#getmaxlisteners) -- [listenerCount](MediaStreamTrack.md#listenercount) -- [listeners](MediaStreamTrack.md#listeners) -- [off](MediaStreamTrack.md#off) -- [on](MediaStreamTrack.md#on) -- [once](MediaStreamTrack.md#once) -- [prependListener](MediaStreamTrack.md#prependlistener) -- [prependOnceListener](MediaStreamTrack.md#prependoncelistener) -- [rawListeners](MediaStreamTrack.md#rawlisteners) -- [removeAllListeners](MediaStreamTrack.md#removealllisteners) -- [removeEventListener](MediaStreamTrack.md#removeeventlistener) -- [removeListener](MediaStreamTrack.md#removelistener) -- [setMaxListeners](MediaStreamTrack.md#setmaxlisteners) -- [stop](MediaStreamTrack.md#stop) -- [writeRtp](MediaStreamTrack.md#writertp) -- [addAbortListener](MediaStreamTrack.md#addabortlistener) -- [getEventListeners](MediaStreamTrack.md#geteventlisteners) -- [getMaxListeners](MediaStreamTrack.md#getmaxlisteners-1) -- [listenerCount](MediaStreamTrack.md#listenercount-1) -- [on](MediaStreamTrack.md#on-1) -- [once](MediaStreamTrack.md#once-1) -- [setMaxListeners](MediaStreamTrack.md#setmaxlisteners-1) - ## Constructors -### constructor +### new MediaStreamTrack() -• **new MediaStreamTrack**(`props`): [`MediaStreamTrack`](MediaStreamTrack.md) +> **new MediaStreamTrack**(`props`): [`MediaStreamTrack`](MediaStreamTrack.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`MediaStreamTrack`](MediaStreamTrack.md)\> & `Pick`\<[`MediaStreamTrack`](MediaStreamTrack.md), ``"kind"``\> | +• **props**: `Partial`\<[`MediaStreamTrack`](MediaStreamTrack.md)\> & `Pick`\<[`MediaStreamTrack`](MediaStreamTrack.md), `"kind"`\> #### Returns @@ -85,147 +26,147 @@ #### Overrides -EventTarget.constructor +`EventTarget.constructor` ## Properties -### codec +### codec? -• `Optional` **codec**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) +> `optional` **codec**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) -___ +*** ### enabled -• **enabled**: `boolean` = `true` +> **enabled**: `boolean` = `true` todo impl -___ +*** -### header +### header? -• `Optional` **header**: [`RtpHeader`](RtpHeader.md) +> `optional` **header**: [`RtpHeader`](RtpHeader.md) -___ +*** -### id +### id? -• `Optional` **id**: `string` +> `optional` **id**: `string` -___ +*** ### kind -• **kind**: [`Kind`](../modules.md#kind) +> **kind**: [`Kind`](../type-aliases/Kind.md) -___ +*** ### label -• **label**: `string` +> **label**: `string` -___ +*** ### muted -• **muted**: `boolean` = `true` +> **muted**: `boolean` = `true` -___ +*** ### onReceiveRtcp -• `Readonly` **onReceiveRtcp**: `Event`\<[[`RtcpPacket`](../modules.md#rtcppacket)]\> +> `readonly` **onReceiveRtcp**: [`Event`](Event.md)\<[[`RtcpPacket`](../type-aliases/RtcpPacket.md)]\> -___ +*** ### onReceiveRtp -• `Readonly` **onReceiveRtp**: `Event`\<[[`RtpPacket`](RtpPacket.md)]\> +> `readonly` **onReceiveRtp**: [`Event`](Event.md)\<[[`RtpPacket`](RtpPacket.md)]\> -___ +*** ### onSourceChanged -• `Readonly` **onSourceChanged**: `Event`\<[`Pick`\<[`RtpHeader`](RtpHeader.md), ``"sequenceNumber"`` \| ``"timestamp"``\>]\> +> `readonly` **onSourceChanged**: [`Event`](Event.md)\<[`Pick`\<[`RtpHeader`](RtpHeader.md), `"sequenceNumber"` \| `"timestamp"`\>]\> -___ +*** ### remote -• **remote**: `boolean` = `false` +> **remote**: `boolean` = `false` -___ +*** -### rid +### rid? -• `Optional` **rid**: `string` +> `optional` **rid**: `string` -___ +*** -### ssrc +### ssrc? -• `Optional` **ssrc**: `number` +> `optional` **ssrc**: `number` mediaSsrc -___ +*** ### stopped -• **stopped**: `boolean` = `false` +> **stopped**: `boolean` = `false` -___ +*** -### streamId +### streamId? -• `Optional` **streamId**: `string` +> `optional` **streamId**: `string` MediaStream ID -___ +*** ### uuid -• `Readonly` **uuid**: `string` +> `readonly` **uuid**: `string` -___ +*** ### captureRejectionSymbol -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) +> `readonly` `static` **captureRejectionSymbol**: *typeof* [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) #### Inherited from -EventTarget.captureRejectionSymbol +`EventTarget.captureRejectionSymbol` -___ +*** ### captureRejections -▪ `Static` **captureRejections**: `boolean` +> `static` **captureRejections**: `boolean` Sets or gets the default captureRejection value for all emitters. #### Inherited from -EventTarget.captureRejections +`EventTarget.captureRejections` -___ +*** ### defaultMaxListeners -▪ `Static` **defaultMaxListeners**: `number` +> `static` **defaultMaxListeners**: `number` #### Inherited from -EventTarget.defaultMaxListeners +`EventTarget.defaultMaxListeners` -___ +*** ### errorMonitor -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](RTCDataChannel.md#errormonitor) +> `readonly` `static` **errorMonitor**: *typeof* [`errorMonitor`](RTCDataChannel.md#errormonitor) This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular @@ -237,21 +178,21 @@ regular `'error'` listener is installed. #### Inherited from -EventTarget.errorMonitor +`EventTarget.errorMonitor` ## Methods -### [captureRejectionSymbol] +### \[captureRejectionSymbol\]()? -▸ **[captureRejectionSymbol]**(`error`, `event`, `...args`): `void` +> `optional` **\[captureRejectionSymbol\]**(`error`, `event`, ...`args`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `event` | `string` | -| `...args` | `any`[] | +• **error**: `Error` + +• **event**: `string` + +• ...**args**: `any`[] #### Returns @@ -259,20 +200,19 @@ EventTarget.errorMonitor #### Inherited from -EventTarget.[captureRejectionSymbol] +`EventTarget.[captureRejectionSymbol]` -___ +*** -### addEventListener +### addEventListener() -▸ **addEventListener**(`type`, `listener`): `void` +> **addEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -280,40 +220,39 @@ ___ #### Inherited from -EventTarget.addEventListener +`EventTarget.addEventListener` -___ +*** -### addListener +### addListener() -▸ **addListener**(`eventName`, `listener`): `this` +> **addListener**(`eventName`, `listener`): `this` Alias for `emitter.on(eventName, listener)`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.addListener +`EventTarget.addListener` -___ +*** -### emit +### emit() -▸ **emit**(`eventName`, `...args`): `boolean` +> **emit**(`eventName`, ...`args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -355,28 +294,27 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | +• **eventName**: `string` \| `symbol` + +• ...**args**: `any`[] #### Returns `boolean` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.emit +`EventTarget.emit` -___ +*** -### eventNames +### eventNames() -▸ **eventNames**(): (`string` \| `symbol`)[] +> **eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -398,19 +336,19 @@ console.log(myEE.eventNames()); (`string` \| `symbol`)[] -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.eventNames +`EventTarget.eventNames` -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(): `number` +> **getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](MediaStreamTrack.md#defaultmaxlisteners). @@ -419,19 +357,19 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](MediaSt `number` -**`Since`** +#### Since v1.0.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### listenerCount +### listenerCount() -▸ **listenerCount**(`eventName`, `listener?`): `number` +> **listenerCount**(`eventName`, `listener`?): `number` Returns the number of listeners listening to the event named `eventName`. @@ -440,28 +378,31 @@ is found in the list of the listeners of the event. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | -| `listener?` | `Function` | The event handler function | +• **eventName**: `string` \| `symbol` + +The name of the event being listened for + +• **listener?**: `Function` + +The event handler function #### Returns `number` -**`Since`** +#### Since v3.2.0 #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### listeners +### listeners() -▸ **listeners**(`eventName`): `Function`[] +> **listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -475,54 +416,51 @@ console.log(util.inspect(server.listeners('connection'))); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.listeners +`EventTarget.listeners` -___ +*** -### off +### off() -▸ **off**(`eventName`, `listener`): `this` +> **off**(`eventName`, `listener`): `this` Alias for `emitter.removeListener()`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v10.0.0 #### Inherited from -EventTarget.off +`EventTarget.off` -___ +*** -### on +### on() -▸ **on**(`eventName`, `listener`): `this` +> **on**(`eventName`, `listener`): `this` Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -552,28 +490,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.1.101 #### Inherited from -EventTarget.on +`EventTarget.on` -___ +*** -### once +### once() -▸ **once**(`eventName`, `listener`): `this` +> **once**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -601,28 +542,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.3.0 #### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### prependListener +### prependListener() -▸ **prependListener**(`eventName`, `listener`): `this` +> **prependListener**(`eventName`, `listener`): `this` Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -639,28 +583,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependListener +`EventTarget.prependListener` -___ +*** -### prependOnceListener +### prependOnceListener() -▸ **prependOnceListener**(`eventName`, `listener`): `this` +> **prependOnceListener**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -675,28 +622,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependOnceListener +`EventTarget.prependOnceListener` -___ +*** -### rawListeners +### rawListeners() -▸ **rawListeners**(`eventName`): `Function`[] +> **rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -727,27 +677,25 @@ emitter.emit('log'); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v9.4.0 #### Inherited from -EventTarget.rawListeners +`EventTarget.rawListeners` -___ +*** -### removeAllListeners +### removeAllListeners() -▸ **removeAllListeners**(`event?`): `this` +> **removeAllListeners**(`event`?): `this` Removes all listeners, or those of the specified `eventName`. @@ -759,34 +707,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | +• **event?**: `string` \| `symbol` #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeAllListeners +`EventTarget.removeAllListeners` -___ +*** -### removeEventListener +### removeEventListener() -▸ **removeEventListener**(`type`, `listener`): `void` +> **removeEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -794,13 +739,13 @@ ___ #### Inherited from -EventTarget.removeEventListener +`EventTarget.removeEventListener` -___ +*** -### removeListener +### removeListener() -▸ **removeListener**(`eventName`, `listener`): `this` +> **removeListener**(`eventName`, `listener`): `this` Removes the specified `listener` from the listener array for the event named`eventName`. @@ -881,28 +826,27 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeListener +`EventTarget.removeListener` -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n`): `this` +> **setMaxListeners**(`n`): `this` By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -913,53 +857,51 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `n` | `number` | +• **n**: `number` #### Returns `this` -**`Since`** +#### Since v0.3.5 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` -___ +*** -### stop +### stop() -▸ **stop**(): `void` +> **stop**(): `void` #### Returns `void` -___ +*** -### writeRtp +### writeRtp() -▸ **writeRtp**(`rtp`): `void` +> **writeRtp**(`rtp`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `rtp` | `Buffer` \| [`RtpPacket`](RtpPacket.md) | +• **rtp**: `Buffer` \| [`RtpPacket`](RtpPacket.md) #### Returns `void` -___ +*** + +### addAbortListener() -### addAbortListener +> `static` **addAbortListener**(`signal`, `resource`): `Disposable` -▸ **addAbortListener**(`signal`, `resource`): `Disposable` +**`Experimental`** Listens once to the `abort` event on the provided `signal`. @@ -993,10 +935,9 @@ function example(signal) { #### Parameters -| Name | Type | -| :------ | :------ | -| `signal` | `AbortSignal` | -| `resource` | (`event`: `Event`) => `void` | +• **signal**: `AbortSignal` + +• **resource** #### Returns @@ -1004,19 +945,19 @@ function example(signal) { Disposable that removes the `abort` listener. -**`Since`** +#### Since v18.18.0 #### Inherited from -EventTarget.addAbortListener +`EventTarget.addAbortListener` -___ +*** -### getEventListeners +### getEventListeners() -▸ **getEventListeners**(`emitter`, `name`): `Function`[] +> `static` **getEventListeners**(`emitter`, `name`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1045,28 +986,27 @@ const { getEventListeners, EventEmitter } = require('events'); #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | -| `name` | `string` \| `symbol` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` + +• **name**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v15.2.0, v14.17.0 #### Inherited from -EventTarget.getEventListeners +`EventTarget.getEventListeners` -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(`emitter`): `number` +> `static` **getMaxListeners**(`emitter`): `number` Returns the currently set max amount of listeners. @@ -1096,27 +1036,25 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` #### Returns `number` -**`Since`** +#### Since v18.17.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### listenerCount +### ~~listenerCount()~~ -▸ **listenerCount**(`emitter`, `eventName`): `number` +> `static` **listenerCount**(`emitter`, `eventName`): `number` A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. @@ -1131,32 +1069,35 @@ console.log(listenerCount(myEmitter, 'event')); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | +• **emitter**: `EventEmitter` + +The emitter to query + +• **eventName**: `string` \| `symbol` + +The event name #### Returns `number` -**`Since`** +#### Since v0.9.12 -**`Deprecated`** +#### Deprecated Since v3.2.0 - Use `listenerCount` instead. #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### on +### on() -▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`\<`any`\> +> `static` **on**(`emitter`, `eventName`, `options`?): `AsyncIterableIterator`\<`any`\> ```js const { on, EventEmitter } = require('events'); @@ -1214,11 +1155,13 @@ process.nextTick(() => ac.abort()); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | `StaticEventEmitterOptions` | - | +• **emitter**: `EventEmitter` + +• **eventName**: `string` + +The name of the event being listened for + +• **options?**: `StaticEventEmitterOptions` #### Returns @@ -1226,19 +1169,21 @@ process.nextTick(() => ac.abort()); that iterates `eventName` events emitted by the `emitter` -**`Since`** +#### Since v13.6.0, v12.16.0 #### Inherited from -EventTarget.on +`EventTarget.on` + +*** -___ +### once() -### once +#### once(emitter, eventName, options) -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1320,49 +1265,51 @@ ac.abort(); // Abort waiting for the event ee.emit('foo'); // Prints: Waiting for the event was canceled! ``` -#### Parameters +##### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `_NodeEventTarget` | -| `eventName` | `string` \| `symbol` | -| `options?` | `StaticEventEmitterOptions` | +• **emitter**: `_NodeEventTarget` -#### Returns +• **eventName**: `string` \| `symbol` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -**`Since`** +##### Since v11.13.0, v10.16.0 -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +#### once(emitter, eventName, options) -#### Parameters +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> -| Name | Type | -| :------ | :------ | -| `emitter` | `_DOMEventTarget` | -| `eventName` | `string` | -| `options?` | `StaticEventEmitterOptions` | +##### Parameters -#### Returns +• **emitter**: `_DOMEventTarget` + +• **eventName**: `string` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n?`, `...eventTargets`): `void` +> `static` **setMaxListeners**(`n`?, ...`eventTargets`?): `void` ```js const { @@ -1378,19 +1325,20 @@ setMaxListeners(5, target, emitter); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | -| `...eventTargets` | (`EventEmitter` \| `_DOMEventTarget`)[] | - | +• **n?**: `number` + +A non-negative number. The maximum number of listeners per `EventTarget` event. + +• ...**eventTargets?**: (`EventEmitter` \| `_DOMEventTarget`)[] #### Returns `void` -**`Since`** +#### Since v15.4.0 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` diff --git a/doc/classes/MediaStreamTrackFactory.md b/doc/classes/MediaStreamTrackFactory.md index 456cf915e..75f12aeda 100644 --- a/doc/classes/MediaStreamTrackFactory.md +++ b/doc/classes/MediaStreamTrackFactory.md @@ -1,22 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / MediaStreamTrackFactory +[**werift**](../README.md) • **Docs** -# Class: MediaStreamTrackFactory - -## Table of contents - -### Constructors - -- [constructor](MediaStreamTrackFactory.md#constructor) +*** -### Methods +[werift](../globals.md) / MediaStreamTrackFactory -- [rtpSource](MediaStreamTrackFactory.md#rtpsource) +# Class: MediaStreamTrackFactory ## Constructors -### constructor +### new MediaStreamTrackFactory() -• **new MediaStreamTrackFactory**(): [`MediaStreamTrackFactory`](MediaStreamTrackFactory.md) +> **new MediaStreamTrackFactory**(): [`MediaStreamTrackFactory`](MediaStreamTrackFactory.md) #### Returns @@ -24,17 +18,19 @@ ## Methods -### rtpSource +### rtpSource() -▸ **rtpSource**(`«destructured»`): `Promise`\ `void`]\> +> `static` **rtpSource**(`__namedParameters`): `Promise`\ `void`]\> #### Parameters -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `kind` | ``"audio"`` \| ``"video"`` | -| › `port?` | `number` | +• **\_\_namedParameters** + +• **\_\_namedParameters.cb?** + +• **\_\_namedParameters.kind**: `"audio"` \| `"video"` + +• **\_\_namedParameters.port?**: `number` #### Returns diff --git a/doc/classes/Message.md b/doc/classes/Message.md new file mode 100644 index 000000000..e45c6151e --- /dev/null +++ b/doc/classes/Message.md @@ -0,0 +1,219 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Message + +# Class: Message + +## Extends + +- `AttributeRepository` + +## Constructors + +### new Message() + +> **new Message**(`messageMethod`, `messageClass`, `transactionId`, `attributes`): [`Message`](Message.md) + +#### Parameters + +• **messageMethod**: [`methods`](../enumerations/methods.md) + +• **messageClass**: [`classes`](../enumerations/classes.md) + +• **transactionId**: `Buffer` = `...` + +• **attributes**: `AttributePair`[] = `[]` + +#### Returns + +[`Message`](Message.md) + +#### Overrides + +`AttributeRepository.constructor` + +## Properties + +### attributes + +> `protected` **attributes**: `AttributePair`[] = `[]` + +#### Inherited from + +`AttributeRepository.attributes` + +*** + +### messageClass + +> **messageClass**: [`classes`](../enumerations/classes.md) + +*** + +### messageMethod + +> **messageMethod**: [`methods`](../enumerations/methods.md) + +*** + +### transactionId + +> **transactionId**: `Buffer` + +## Accessors + +### attributesKeys + +> `get` **attributesKeys**(): (`"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"`)[] + +#### Returns + +(`"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"`)[] + +#### Inherited from + +`AttributeRepository.attributesKeys` + +*** + +### bytes + +> `get` **bytes**(): `Buffer` + +#### Returns + +`Buffer` + +*** + +### transactionIdHex + +> `get` **transactionIdHex**(): `string` + +#### Returns + +`string` + +## Methods + +### addFingerprint() + +> **addFingerprint**(): `void` + +#### Returns + +`void` + +*** + +### addMessageIntegrity() + +> **addMessageIntegrity**(`key`): [`Message`](Message.md) + +#### Parameters + +• **key**: `Buffer` + +#### Returns + +[`Message`](Message.md) + +*** + +### clear() + +> **clear**(): `void` + +#### Returns + +`void` + +#### Inherited from + +`AttributeRepository.clear` + +*** + +### getAttributeValue() + +> **getAttributeValue**(`key`): `any` + +#### Parameters + +• **key**: `"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"` + +#### Returns + +`any` + +#### Inherited from + +`AttributeRepository.getAttributeValue` + +*** + +### getAttributes() + +> **getAttributes**(): `AttributePair`[] + +#### Returns + +`AttributePair`[] + +#### Inherited from + +`AttributeRepository.getAttributes` + +*** + +### messageIntegrity() + +> **messageIntegrity**(`key`): `Buffer` + +#### Parameters + +• **key**: `Buffer` + +#### Returns + +`Buffer` + +*** + +### setAttribute() + +> **setAttribute**(`key`, `value`): [`Message`](Message.md) + +#### Parameters + +• **key**: `"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"` + +• **value**: `any` + +#### Returns + +[`Message`](Message.md) + +#### Inherited from + +`AttributeRepository.setAttribute` + +*** + +### toJSON() + +> **toJSON**(): `object` + +#### Returns + +`object` + +##### messageClass + +> **messageClass**: `string` + +##### messageMethod + +> **messageMethod**: `string` diff --git a/doc/classes/OpusRtpPayload.md b/doc/classes/OpusRtpPayload.md index 6a12771a1..63b5edbd1 100644 --- a/doc/classes/OpusRtpPayload.md +++ b/doc/classes/OpusRtpPayload.md @@ -1,4 +1,8 @@ -[werift](../README.md) / [Exports](../modules.md) / OpusRtpPayload +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / OpusRtpPayload # Class: OpusRtpPayload @@ -6,31 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](OpusRtpPayload.md#constructor) - -### Properties - -- [payload](OpusRtpPayload.md#payload) - -### Accessors - -- [isKeyframe](OpusRtpPayload.md#iskeyframe) - -### Methods - -- [createCodecPrivate](OpusRtpPayload.md#createcodecprivate) -- [deSerialize](OpusRtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](OpusRtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new OpusRtpPayload() -• **new OpusRtpPayload**(): [`OpusRtpPayload`](OpusRtpPayload.md) +> **new OpusRtpPayload**(): [`OpusRtpPayload`](OpusRtpPayload.md) #### Returns @@ -40,17 +24,17 @@ ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -58,51 +42,45 @@ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) ## Methods -### createCodecPrivate +### createCodecPrivate() -▸ **createCodecPrivate**(`samplingFrequency?`): `Buffer` +> `static` **createCodecPrivate**(`samplingFrequency`): `Buffer` #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `samplingFrequency` | `number` | `48000` | +• **samplingFrequency**: `number` = `48000` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`OpusRtpPayload`](OpusRtpPayload.md) +> `static` **deSerialize**(`buf`): [`OpusRtpPayload`](OpusRtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`OpusRtpPayload`](OpusRtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/doc/classes/PacketResult.md b/doc/classes/PacketResult.md index 4f039a043..0ddd1ae51 100644 --- a/doc/classes/PacketResult.md +++ b/doc/classes/PacketResult.md @@ -1,31 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / PacketResult +[**werift**](../README.md) • **Docs** -# Class: PacketResult - -## Table of contents - -### Constructors +*** -- [constructor](PacketResult.md#constructor) +[werift](../globals.md) / PacketResult -### Properties - -- [delta](PacketResult.md#delta) -- [received](PacketResult.md#received) -- [receivedAtMs](PacketResult.md#receivedatms) -- [sequenceNumber](PacketResult.md#sequencenumber) +# Class: PacketResult ## Constructors -### constructor +### new PacketResult() -• **new PacketResult**(`props`): [`PacketResult`](PacketResult.md) +> **new PacketResult**(`props`): [`PacketResult`](PacketResult.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`PacketResult`](PacketResult.md)\> | +• **props**: `Partial`\<[`PacketResult`](PacketResult.md)\> #### Returns @@ -35,22 +24,22 @@ ### delta -• **delta**: `number` = `0` +> **delta**: `number` = `0` -___ +*** ### received -• **received**: `boolean` = `false` +> **received**: `boolean` = `false` -___ +*** ### receivedAtMs -• **receivedAtMs**: `number` = `0` +> **receivedAtMs**: `number` = `0` -___ +*** ### sequenceNumber -• **sequenceNumber**: `number` = `0` +> **sequenceNumber**: `number` = `0` diff --git a/doc/classes/PictureLossIndication.md b/doc/classes/PictureLossIndication.md index 09c4c4be4..d23bdad0a 100644 --- a/doc/classes/PictureLossIndication.md +++ b/doc/classes/PictureLossIndication.md @@ -1,37 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / PictureLossIndication +[**werift**](../README.md) • **Docs** -# Class: PictureLossIndication - -## Table of contents - -### Constructors - -- [constructor](PictureLossIndication.md#constructor) +*** -### Properties +[werift](../globals.md) / PictureLossIndication -- [count](PictureLossIndication.md#count) -- [length](PictureLossIndication.md#length) -- [mediaSsrc](PictureLossIndication.md#mediassrc) -- [senderSsrc](PictureLossIndication.md#senderssrc) -- [count](PictureLossIndication.md#count-1) - -### Methods - -- [serialize](PictureLossIndication.md#serialize) -- [deSerialize](PictureLossIndication.md#deserialize) +# Class: PictureLossIndication ## Constructors -### constructor +### new PictureLossIndication() -• **new PictureLossIndication**(`props?`): [`PictureLossIndication`](PictureLossIndication.md) +> **new PictureLossIndication**(`props`): [`PictureLossIndication`](PictureLossIndication.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`PictureLossIndication`](PictureLossIndication.md)\> | +• **props**: `Partial`\<[`PictureLossIndication`](PictureLossIndication.md)\> = `{}` #### Returns @@ -41,53 +24,51 @@ ### count -• **count**: `number` = `PictureLossIndication.count` +> **count**: `number` = `PictureLossIndication.count` -___ +*** ### length -• **length**: `number` = `2` +> **length**: `number` = `2` -___ +*** ### mediaSsrc -• **mediaSsrc**: `number` +> **mediaSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `1` +> `static` **count**: `number` = `1` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`PictureLossIndication`](PictureLossIndication.md) +> `static` **deSerialize**(`data`): [`PictureLossIndication`](PictureLossIndication.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/PromiseQueue.md b/doc/classes/PromiseQueue.md index cf86dc874..a93671f7a 100644 --- a/doc/classes/PromiseQueue.md +++ b/doc/classes/PromiseQueue.md @@ -1,28 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / PromiseQueue +[**werift**](../README.md) • **Docs** -# Class: PromiseQueue - -## Table of contents - -### Constructors - -- [constructor](PromiseQueue.md#constructor) +*** -### Properties +[werift](../globals.md) / PromiseQueue -- [queue](PromiseQueue.md#queue) -- [running](PromiseQueue.md#running) - -### Methods - -- [cancel](PromiseQueue.md#cancel) -- [push](PromiseQueue.md#push) +# Class: PromiseQueue ## Constructors -### constructor +### new PromiseQueue() -• **new PromiseQueue**(): [`PromiseQueue`](PromiseQueue.md) +> **new PromiseQueue**(): [`PromiseQueue`](PromiseQueue.md) #### Returns @@ -32,41 +20,37 @@ ### queue -• **queue**: \{ `done`: (...`args`: `any`[]) => `void` ; `failed`: (...`args`: `any`[]) => `void` ; `promise`: () => `Promise`\<`unknown`\> }[] = `[]` +> **queue**: `object`[] = `[]` -___ +*** ### running -• **running**: `boolean` = `false` +> **running**: `boolean` = `false` ## Methods -### cancel +### cancel() -▸ **cancel**(): `void` +> **cancel**(): `void` #### Returns `void` -___ +*** -### push +### push() -▸ **push**\<`T`\>(`promise`): `Promise`\<`T`\> +> **push**\<`T`\>(`promise`): `Promise`\<`T`\> -#### Type parameters +#### Type Parameters -| Name | -| :------ | -| `T` | +• **T** #### Parameters -| Name | Type | -| :------ | :------ | -| `promise` | () => `Promise`\<`T`\> | +• **promise** #### Returns diff --git a/doc/classes/RTCCertificate.md b/doc/classes/RTCCertificate.md index 436f56873..55d2133d7 100644 --- a/doc/classes/RTCCertificate.md +++ b/doc/classes/RTCCertificate.md @@ -1,37 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCCertificate +[**werift**](../README.md) • **Docs** -# Class: RTCCertificate - -## Table of contents - -### Constructors - -- [constructor](RTCCertificate.md#constructor) - -### Properties - -- [certPem](RTCCertificate.md#certpem) -- [privateKey](RTCCertificate.md#privatekey) -- [publicKey](RTCCertificate.md#publickey) -- [signatureHash](RTCCertificate.md#signaturehash) +*** -### Methods +[werift](../globals.md) / RTCCertificate -- [getFingerprints](RTCCertificate.md#getfingerprints) +# Class: RTCCertificate ## Constructors -### constructor +### new RTCCertificate() -• **new RTCCertificate**(`privateKeyPem`, `certPem`, `signatureHash`): [`RTCCertificate`](RTCCertificate.md) +> **new RTCCertificate**(`privateKeyPem`, `certPem`, `signatureHash`): [`RTCCertificate`](RTCCertificate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `privateKeyPem` | `string` | -| `certPem` | `string` | -| `signatureHash` | [`SignatureHash`](../modules.md#signaturehash) | +• **privateKeyPem**: `string` + +• **certPem**: `string` + +• **signatureHash**: [`SignatureHash`](../type-aliases/SignatureHash.md) #### Returns @@ -41,31 +28,31 @@ ### certPem -• **certPem**: `string` +> **certPem**: `string` -___ +*** ### privateKey -• **privateKey**: `string` +> **privateKey**: `string` -___ +*** ### publicKey -• **publicKey**: `string` +> **publicKey**: `string` -___ +*** ### signatureHash -• **signatureHash**: [`SignatureHash`](../modules.md#signaturehash) +> **signatureHash**: [`SignatureHash`](../type-aliases/SignatureHash.md) ## Methods -### getFingerprints +### getFingerprints() -▸ **getFingerprints**(): [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] +> **getFingerprints**(): [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] #### Returns diff --git a/doc/classes/RTCDataChannel.md b/doc/classes/RTCDataChannel.md index 9b952b1ac..d36d8efb4 100644 --- a/doc/classes/RTCDataChannel.md +++ b/doc/classes/RTCDataChannel.md @@ -1,96 +1,28 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDataChannel +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCDataChannel # Class: RTCDataChannel -## Hierarchy +## Extends - `EventTarget` - ↳ **`RTCDataChannel`** - -## Table of contents - -### Constructors - -- [constructor](RTCDataChannel.md#constructor) - -### Properties - -- [bufferedAmount](RTCDataChannel.md#bufferedamount) -- [bufferedAmountLow](RTCDataChannel.md#bufferedamountlow) -- [error](RTCDataChannel.md#error) -- [id](RTCDataChannel.md#id) -- [isCreatedByRemote](RTCDataChannel.md#iscreatedbyremote) -- [message](RTCDataChannel.md#message) -- [onclose](RTCDataChannel.md#onclose) -- [onclosing](RTCDataChannel.md#onclosing) -- [onerror](RTCDataChannel.md#onerror) -- [onmessage](RTCDataChannel.md#onmessage) -- [onopen](RTCDataChannel.md#onopen) -- [readyState](RTCDataChannel.md#readystate) -- [sendOpen](RTCDataChannel.md#sendopen) -- [stateChanged](RTCDataChannel.md#statechanged) -- [captureRejectionSymbol](RTCDataChannel.md#capturerejectionsymbol) -- [captureRejections](RTCDataChannel.md#capturerejections) -- [defaultMaxListeners](RTCDataChannel.md#defaultmaxlisteners) -- [errorMonitor](RTCDataChannel.md#errormonitor) - -### Accessors - -- [bufferedAmountLowThreshold](RTCDataChannel.md#bufferedamountlowthreshold) -- [label](RTCDataChannel.md#label) -- [maxPacketLifeTime](RTCDataChannel.md#maxpacketlifetime) -- [maxRetransmits](RTCDataChannel.md#maxretransmits) -- [negotiated](RTCDataChannel.md#negotiated) -- [ordered](RTCDataChannel.md#ordered) -- [protocol](RTCDataChannel.md#protocol) - -### Methods - -- [[captureRejectionSymbol]](RTCDataChannel.md#[capturerejectionsymbol]) -- [addBufferedAmount](RTCDataChannel.md#addbufferedamount) -- [addEventListener](RTCDataChannel.md#addeventlistener) -- [addListener](RTCDataChannel.md#addlistener) -- [close](RTCDataChannel.md#close) -- [emit](RTCDataChannel.md#emit) -- [eventNames](RTCDataChannel.md#eventnames) -- [getMaxListeners](RTCDataChannel.md#getmaxlisteners) -- [listenerCount](RTCDataChannel.md#listenercount) -- [listeners](RTCDataChannel.md#listeners) -- [off](RTCDataChannel.md#off) -- [on](RTCDataChannel.md#on) -- [once](RTCDataChannel.md#once) -- [prependListener](RTCDataChannel.md#prependlistener) -- [prependOnceListener](RTCDataChannel.md#prependoncelistener) -- [rawListeners](RTCDataChannel.md#rawlisteners) -- [removeAllListeners](RTCDataChannel.md#removealllisteners) -- [removeEventListener](RTCDataChannel.md#removeeventlistener) -- [removeListener](RTCDataChannel.md#removelistener) -- [send](RTCDataChannel.md#send) -- [setId](RTCDataChannel.md#setid) -- [setMaxListeners](RTCDataChannel.md#setmaxlisteners) -- [setReadyState](RTCDataChannel.md#setreadystate) -- [addAbortListener](RTCDataChannel.md#addabortlistener) -- [getEventListeners](RTCDataChannel.md#geteventlisteners) -- [getMaxListeners](RTCDataChannel.md#getmaxlisteners-1) -- [listenerCount](RTCDataChannel.md#listenercount-1) -- [on](RTCDataChannel.md#on-1) -- [once](RTCDataChannel.md#once-1) -- [setMaxListeners](RTCDataChannel.md#setmaxlisteners-1) - ## Constructors -### constructor +### new RTCDataChannel() -• **new RTCDataChannel**(`transport`, `parameters`, `sendOpen?`): [`RTCDataChannel`](RTCDataChannel.md) +> **new RTCDataChannel**(`transport`, `parameters`, `sendOpen`): [`RTCDataChannel`](RTCDataChannel.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `transport` | [`RTCSctpTransport`](RTCSctpTransport.md) | `undefined` | -| `parameters` | [`RTCDataChannelParameters`](RTCDataChannelParameters.md) | `undefined` | -| `sendOpen` | `boolean` | `true` | +• **transport**: [`RTCSctpTransport`](RTCSctpTransport.md) + +• **parameters**: [`RTCDataChannelParameters`](RTCDataChannelParameters.md) + +• **sendOpen**: `boolean` = `true` #### Returns @@ -98,129 +30,129 @@ #### Overrides -EventTarget.constructor +`EventTarget.constructor` ## Properties ### bufferedAmount -• **bufferedAmount**: `number` = `0` +> **bufferedAmount**: `number` = `0` -___ +*** ### bufferedAmountLow -• `Readonly` **bufferedAmountLow**: `Event`\<`any`[]\> +> `readonly` **bufferedAmountLow**: [`Event`](Event.md)\<`any`[]\> -___ +*** ### error -• `Readonly` **error**: `Event`\<[`Error`]\> +> `readonly` **error**: [`Event`](Event.md)\<[`Error`]\> -___ +*** ### id -• **id**: `number` +> **id**: `number` -___ +*** ### isCreatedByRemote -• **isCreatedByRemote**: `boolean` = `false` +> **isCreatedByRemote**: `boolean` = `false` -___ +*** -### message +### onMessage -• `Readonly` **message**: `Event`\<[`string` \| `Buffer`]\> +> `readonly` **onMessage**: [`Event`](Event.md)\<[`string` \| `Buffer`]\> -___ +*** -### onclose +### onclose? -• `Optional` **onclose**: `Callback` +> `optional` **onclose**: `Callback` -___ +*** -### onclosing +### onclosing? -• `Optional` **onclosing**: `Callback` +> `optional` **onclosing**: `Callback` -___ +*** -### onerror +### onerror? -• `Optional` **onerror**: `CallbackWithValue`\<[`RTCErrorEvent`](../interfaces/RTCErrorEvent.md)\> +> `optional` **onerror**: `CallbackWithValue`\<[`RTCErrorEvent`](../interfaces/RTCErrorEvent.md)\> -___ +*** -### onmessage +### onmessage? -• `Optional` **onmessage**: `CallbackWithValue`\<[`MessageEvent`](../interfaces/MessageEvent.md)\> +> `optional` **onmessage**: `CallbackWithValue`\<[`MessageEvent`](../interfaces/MessageEvent.md)\> -___ +*** -### onopen +### onopen? -• `Optional` **onopen**: `Callback` +> `optional` **onopen**: `Callback` -___ +*** ### readyState -• **readyState**: [`DCState`](../modules.md#dcstate) = `"connecting"` +> **readyState**: [`DCState`](../type-aliases/DCState.md) = `"connecting"` -___ +*** ### sendOpen -• `Readonly` **sendOpen**: `boolean` = `true` +> `readonly` **sendOpen**: `boolean` = `true` -___ +*** ### stateChanged -• `Readonly` **stateChanged**: `Event`\<[[`DCState`](../modules.md#dcstate)]\> +> `readonly` **stateChanged**: [`Event`](Event.md)\<[[`DCState`](../type-aliases/DCState.md)]\> -___ +*** ### captureRejectionSymbol -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) +> `readonly` `static` **captureRejectionSymbol**: *typeof* [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) #### Inherited from -EventTarget.captureRejectionSymbol +`EventTarget.captureRejectionSymbol` -___ +*** ### captureRejections -▪ `Static` **captureRejections**: `boolean` +> `static` **captureRejections**: `boolean` Sets or gets the default captureRejection value for all emitters. #### Inherited from -EventTarget.captureRejections +`EventTarget.captureRejections` -___ +*** ### defaultMaxListeners -▪ `Static` **defaultMaxListeners**: `number` +> `static` **defaultMaxListeners**: `number` #### Inherited from -EventTarget.defaultMaxListeners +`EventTarget.defaultMaxListeners` -___ +*** ### errorMonitor -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](RTCDataChannel.md#errormonitor) +> `readonly` `static` **errorMonitor**: *typeof* [`errorMonitor`](RTCDataChannel.md#errormonitor) This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular @@ -232,85 +164,79 @@ regular `'error'` listener is installed. #### Inherited from -EventTarget.errorMonitor +`EventTarget.errorMonitor` ## Accessors ### bufferedAmountLowThreshold -• `get` **bufferedAmountLowThreshold**(): `number` +> `get` **bufferedAmountLowThreshold**(): `number` -#### Returns - -`number` - -• `set` **bufferedAmountLowThreshold**(`value`): `void` +> `set` **bufferedAmountLowThreshold**(`value`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | `number` | +• **value**: `number` #### Returns -`void` +`number` -___ +*** ### label -• `get` **label**(): `string` +> `get` **label**(): `string` #### Returns `string` -___ +*** ### maxPacketLifeTime -• `get` **maxPacketLifeTime**(): `undefined` \| `number` +> `get` **maxPacketLifeTime**(): `undefined` \| `number` #### Returns `undefined` \| `number` -___ +*** ### maxRetransmits -• `get` **maxRetransmits**(): `undefined` \| `number` +> `get` **maxRetransmits**(): `undefined` \| `number` #### Returns `undefined` \| `number` -___ +*** ### negotiated -• `get` **negotiated**(): `boolean` +> `get` **negotiated**(): `boolean` #### Returns `boolean` -___ +*** ### ordered -• `get` **ordered**(): `boolean` +> `get` **ordered**(): `boolean` #### Returns `boolean` -___ +*** ### protocol -• `get` **protocol**(): `string` +> `get` **protocol**(): `string` #### Returns @@ -318,17 +244,17 @@ ___ ## Methods -### [captureRejectionSymbol] +### \[captureRejectionSymbol\]()? -▸ **[captureRejectionSymbol]**(`error`, `event`, `...args`): `void` +> `optional` **\[captureRejectionSymbol\]**(`error`, `event`, ...`args`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `event` | `string` | -| `...args` | `any`[] | +• **error**: `Error` + +• **event**: `string` + +• ...**args**: `any`[] #### Returns @@ -336,36 +262,33 @@ ___ #### Inherited from -EventTarget.[captureRejectionSymbol] +`EventTarget.[captureRejectionSymbol]` -___ +*** -### addBufferedAmount +### addBufferedAmount() -▸ **addBufferedAmount**(`amount`): `void` +> **addBufferedAmount**(`amount`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `amount` | `number` | +• **amount**: `number` #### Returns `void` -___ +*** -### addEventListener +### addEventListener() -▸ **addEventListener**(`type`, `listener`): `void` +> **addEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -373,50 +296,49 @@ ___ #### Inherited from -EventTarget.addEventListener +`EventTarget.addEventListener` -___ +*** -### addListener +### addListener() -▸ **addListener**(`eventName`, `listener`): `this` +> **addListener**(`eventName`, `listener`): `this` Alias for `emitter.on(eventName, listener)`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.addListener +`EventTarget.addListener` -___ +*** -### close +### close() -▸ **close**(): `void` +> **close**(): `void` #### Returns `void` -___ +*** -### emit +### emit() -▸ **emit**(`eventName`, `...args`): `boolean` +> **emit**(`eventName`, ...`args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -458,28 +380,27 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | +• **eventName**: `string` \| `symbol` + +• ...**args**: `any`[] #### Returns `boolean` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.emit +`EventTarget.emit` -___ +*** -### eventNames +### eventNames() -▸ **eventNames**(): (`string` \| `symbol`)[] +> **eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -501,19 +422,19 @@ console.log(myEE.eventNames()); (`string` \| `symbol`)[] -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.eventNames +`EventTarget.eventNames` -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(): `number` +> **getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](RTCDataChannel.md#defaultmaxlisteners). @@ -522,19 +443,19 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](RTCData `number` -**`Since`** +#### Since v1.0.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### listenerCount +### listenerCount() -▸ **listenerCount**(`eventName`, `listener?`): `number` +> **listenerCount**(`eventName`, `listener`?): `number` Returns the number of listeners listening to the event named `eventName`. @@ -543,28 +464,31 @@ is found in the list of the listeners of the event. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | -| `listener?` | `Function` | The event handler function | +• **eventName**: `string` \| `symbol` + +The name of the event being listened for + +• **listener?**: `Function` + +The event handler function #### Returns `number` -**`Since`** +#### Since v3.2.0 #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### listeners +### listeners() -▸ **listeners**(`eventName`): `Function`[] +> **listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -578,54 +502,51 @@ console.log(util.inspect(server.listeners('connection'))); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.listeners +`EventTarget.listeners` -___ +*** -### off +### off() -▸ **off**(`eventName`, `listener`): `this` +> **off**(`eventName`, `listener`): `this` Alias for `emitter.removeListener()`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v10.0.0 #### Inherited from -EventTarget.off +`EventTarget.off` -___ +*** -### on +### on() -▸ **on**(`eventName`, `listener`): `this` +> **on**(`eventName`, `listener`): `this` Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -655,28 +576,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.1.101 #### Inherited from -EventTarget.on +`EventTarget.on` -___ +*** -### once +### once() -▸ **once**(`eventName`, `listener`): `this` +> **once**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -704,28 +628,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.3.0 #### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### prependListener +### prependListener() -▸ **prependListener**(`eventName`, `listener`): `this` +> **prependListener**(`eventName`, `listener`): `this` Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -742,28 +669,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependListener +`EventTarget.prependListener` -___ +*** -### prependOnceListener +### prependOnceListener() -▸ **prependOnceListener**(`eventName`, `listener`): `this` +> **prependOnceListener**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -778,28 +708,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependOnceListener +`EventTarget.prependOnceListener` -___ +*** -### rawListeners +### rawListeners() -▸ **rawListeners**(`eventName`): `Function`[] +> **rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -830,27 +763,25 @@ emitter.emit('log'); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v9.4.0 #### Inherited from -EventTarget.rawListeners +`EventTarget.rawListeners` -___ +*** -### removeAllListeners +### removeAllListeners() -▸ **removeAllListeners**(`event?`): `this` +> **removeAllListeners**(`event`?): `this` Removes all listeners, or those of the specified `eventName`. @@ -862,34 +793,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | +• **event?**: `string` \| `symbol` #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeAllListeners +`EventTarget.removeAllListeners` -___ +*** -### removeEventListener +### removeEventListener() -▸ **removeEventListener**(`type`, `listener`): `void` +> **removeEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -897,13 +825,13 @@ ___ #### Inherited from -EventTarget.removeEventListener +`EventTarget.removeEventListener` -___ +*** -### removeListener +### removeListener() -▸ **removeListener**(`eventName`, `listener`): `this` +> **removeListener**(`eventName`, `listener`): `this` Removes the specified `listener` from the listener array for the event named`eventName`. @@ -984,60 +912,55 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeListener +`EventTarget.removeListener` -___ +*** -### send +### send() -▸ **send**(`data`): `void` +> **send**(`data`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `string` \| `Buffer` | +• **data**: `string` \| `Buffer` #### Returns `void` -___ +*** -### setId +### setId() -▸ **setId**(`id`): `void` +> **setId**(`id`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `id` | `number` | +• **id**: `number` #### Returns `void` -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n`): `this` +> **setMaxListeners**(`n`): `this` By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -1048,43 +971,41 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `n` | `number` | +• **n**: `number` #### Returns `this` -**`Since`** +#### Since v0.3.5 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` -___ +*** -### setReadyState +### setReadyState() -▸ **setReadyState**(`state`): `void` +> **setReadyState**(`state`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `state` | [`DCState`](../modules.md#dcstate) | +• **state**: [`DCState`](../type-aliases/DCState.md) #### Returns `void` -___ +*** -### addAbortListener +### addAbortListener() -▸ **addAbortListener**(`signal`, `resource`): `Disposable` +> `static` **addAbortListener**(`signal`, `resource`): `Disposable` + +**`Experimental`** Listens once to the `abort` event on the provided `signal`. @@ -1118,10 +1039,9 @@ function example(signal) { #### Parameters -| Name | Type | -| :------ | :------ | -| `signal` | `AbortSignal` | -| `resource` | (`event`: `Event`) => `void` | +• **signal**: `AbortSignal` + +• **resource** #### Returns @@ -1129,19 +1049,19 @@ function example(signal) { Disposable that removes the `abort` listener. -**`Since`** +#### Since v18.18.0 #### Inherited from -EventTarget.addAbortListener +`EventTarget.addAbortListener` -___ +*** -### getEventListeners +### getEventListeners() -▸ **getEventListeners**(`emitter`, `name`): `Function`[] +> `static` **getEventListeners**(`emitter`, `name`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1170,28 +1090,27 @@ const { getEventListeners, EventEmitter } = require('events'); #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | -| `name` | `string` \| `symbol` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` + +• **name**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v15.2.0, v14.17.0 #### Inherited from -EventTarget.getEventListeners +`EventTarget.getEventListeners` -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(`emitter`): `number` +> `static` **getMaxListeners**(`emitter`): `number` Returns the currently set max amount of listeners. @@ -1221,27 +1140,25 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` #### Returns `number` -**`Since`** +#### Since v18.17.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### listenerCount +### ~~listenerCount()~~ -▸ **listenerCount**(`emitter`, `eventName`): `number` +> `static` **listenerCount**(`emitter`, `eventName`): `number` A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. @@ -1256,32 +1173,35 @@ console.log(listenerCount(myEmitter, 'event')); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | +• **emitter**: `EventEmitter` + +The emitter to query + +• **eventName**: `string` \| `symbol` + +The event name #### Returns `number` -**`Since`** +#### Since v0.9.12 -**`Deprecated`** +#### Deprecated Since v3.2.0 - Use `listenerCount` instead. #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### on +### on() -▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`\<`any`\> +> `static` **on**(`emitter`, `eventName`, `options`?): `AsyncIterableIterator`\<`any`\> ```js const { on, EventEmitter } = require('events'); @@ -1339,11 +1259,13 @@ process.nextTick(() => ac.abort()); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | `StaticEventEmitterOptions` | - | +• **emitter**: `EventEmitter` + +• **eventName**: `string` + +The name of the event being listened for + +• **options?**: `StaticEventEmitterOptions` #### Returns @@ -1351,19 +1273,21 @@ process.nextTick(() => ac.abort()); that iterates `eventName` events emitted by the `emitter` -**`Since`** +#### Since v13.6.0, v12.16.0 #### Inherited from -EventTarget.on +`EventTarget.on` -___ +*** -### once +### once() -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +#### once(emitter, eventName, options) + +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1445,49 +1369,51 @@ ac.abort(); // Abort waiting for the event ee.emit('foo'); // Prints: Waiting for the event was canceled! ``` -#### Parameters +##### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `_NodeEventTarget` | -| `eventName` | `string` \| `symbol` | -| `options?` | `StaticEventEmitterOptions` | +• **emitter**: `_NodeEventTarget` -#### Returns +• **eventName**: `string` \| `symbol` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -**`Since`** +##### Since v11.13.0, v10.16.0 -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +#### once(emitter, eventName, options) -#### Parameters +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> -| Name | Type | -| :------ | :------ | -| `emitter` | `_DOMEventTarget` | -| `eventName` | `string` | -| `options?` | `StaticEventEmitterOptions` | +##### Parameters -#### Returns +• **emitter**: `_DOMEventTarget` + +• **eventName**: `string` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n?`, `...eventTargets`): `void` +> `static` **setMaxListeners**(`n`?, ...`eventTargets`?): `void` ```js const { @@ -1503,19 +1429,20 @@ setMaxListeners(5, target, emitter); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | -| `...eventTargets` | (`EventEmitter` \| `_DOMEventTarget`)[] | - | +• **n?**: `number` + +A non-negative number. The maximum number of listeners per `EventTarget` event. + +• ...**eventTargets?**: (`EventEmitter` \| `_DOMEventTarget`)[] #### Returns `void` -**`Since`** +#### Since v15.4.0 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` diff --git a/doc/classes/RTCDataChannelParameters.md b/doc/classes/RTCDataChannelParameters.md index ee114edf2..afaf6ce6a 100644 --- a/doc/classes/RTCDataChannelParameters.md +++ b/doc/classes/RTCDataChannelParameters.md @@ -1,34 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDataChannelParameters +[**werift**](../README.md) • **Docs** -# Class: RTCDataChannelParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCDataChannelParameters.md#constructor) +[werift](../globals.md) / RTCDataChannelParameters -### Properties - -- [id](RTCDataChannelParameters.md#id) -- [label](RTCDataChannelParameters.md#label) -- [maxPacketLifeTime](RTCDataChannelParameters.md#maxpacketlifetime) -- [maxRetransmits](RTCDataChannelParameters.md#maxretransmits) -- [negotiated](RTCDataChannelParameters.md#negotiated) -- [ordered](RTCDataChannelParameters.md#ordered) -- [protocol](RTCDataChannelParameters.md#protocol) +# Class: RTCDataChannelParameters ## Constructors -### constructor +### new RTCDataChannelParameters() -• **new RTCDataChannelParameters**(`props?`): [`RTCDataChannelParameters`](RTCDataChannelParameters.md) +> **new RTCDataChannelParameters**(`props`): [`RTCDataChannelParameters`](RTCDataChannelParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCDataChannelParameters`](RTCDataChannelParameters.md)\> | +• **props**: `Partial`\<[`RTCDataChannelParameters`](RTCDataChannelParameters.md)\> = `{}` #### Returns @@ -38,40 +24,40 @@ ### id -• **id**: `number` +> **id**: `number` -___ +*** ### label -• **label**: `string` = `""` +> **label**: `string` = `""` -___ +*** -### maxPacketLifeTime +### maxPacketLifeTime? -• `Optional` **maxPacketLifeTime**: `number` +> `optional` **maxPacketLifeTime**: `number` -___ +*** -### maxRetransmits +### maxRetransmits? -• `Optional` **maxRetransmits**: `number` +> `optional` **maxRetransmits**: `number` -___ +*** ### negotiated -• **negotiated**: `boolean` = `false` +> **negotiated**: `boolean` = `false` -___ +*** ### ordered -• **ordered**: `boolean` = `true` +> **ordered**: `boolean` = `true` -___ +*** ### protocol -• **protocol**: `string` = `""` +> **protocol**: `string` = `""` diff --git a/doc/classes/RTCDtlsFingerprint.md b/doc/classes/RTCDtlsFingerprint.md index f73da128a..552bcef15 100644 --- a/doc/classes/RTCDtlsFingerprint.md +++ b/doc/classes/RTCDtlsFingerprint.md @@ -1,30 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDtlsFingerprint +[**werift**](../README.md) • **Docs** -# Class: RTCDtlsFingerprint - -## Table of contents - -### Constructors +*** -- [constructor](RTCDtlsFingerprint.md#constructor) +[werift](../globals.md) / RTCDtlsFingerprint -### Properties - -- [algorithm](RTCDtlsFingerprint.md#algorithm) -- [value](RTCDtlsFingerprint.md#value) +# Class: RTCDtlsFingerprint ## Constructors -### constructor +### new RTCDtlsFingerprint() -• **new RTCDtlsFingerprint**(`algorithm`, `value`): [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md) +> **new RTCDtlsFingerprint**(`algorithm`, `value`): [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `algorithm` | `string` | -| `value` | `string` | +• **algorithm**: `string` + +• **value**: `string` #### Returns @@ -34,10 +26,10 @@ ### algorithm -• **algorithm**: `string` +> **algorithm**: `string` -___ +*** ### value -• **value**: `string` +> **value**: `string` diff --git a/doc/classes/RTCDtlsParameters.md b/doc/classes/RTCDtlsParameters.md index df131673a..2560d867d 100644 --- a/doc/classes/RTCDtlsParameters.md +++ b/doc/classes/RTCDtlsParameters.md @@ -1,30 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDtlsParameters +[**werift**](../README.md) • **Docs** -# Class: RTCDtlsParameters - -## Table of contents - -### Constructors - -- [constructor](RTCDtlsParameters.md#constructor) +*** -### Properties +[werift](../globals.md) / RTCDtlsParameters -- [fingerprints](RTCDtlsParameters.md#fingerprints) -- [role](RTCDtlsParameters.md#role) +# Class: RTCDtlsParameters ## Constructors -### constructor +### new RTCDtlsParameters() -• **new RTCDtlsParameters**(`fingerprints?`, `role`): [`RTCDtlsParameters`](RTCDtlsParameters.md) +> **new RTCDtlsParameters**(`fingerprints`, `role`): [`RTCDtlsParameters`](RTCDtlsParameters.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `fingerprints` | [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] | `[]` | -| `role` | ``"auto"`` \| ``"server"`` \| ``"client"`` | `undefined` | +• **fingerprints**: [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] = `[]` + +• **role**: `"auto"` \| `"server"` \| `"client"` #### Returns @@ -34,10 +26,10 @@ ### fingerprints -• **fingerprints**: [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] = `[]` +> **fingerprints**: [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] = `[]` -___ +*** ### role -• **role**: ``"auto"`` \| ``"server"`` \| ``"client"`` +> **role**: `"auto"` \| `"server"` \| `"client"` diff --git a/doc/classes/RTCDtlsTransport.md b/doc/classes/RTCDtlsTransport.md index f7234f2ce..a6dfe0fb0 100644 --- a/doc/classes/RTCDtlsTransport.md +++ b/doc/classes/RTCDtlsTransport.md @@ -1,62 +1,28 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDtlsTransport +[**werift**](../README.md) • **Docs** -# Class: RTCDtlsTransport - -## Table of contents - -### Constructors +*** -- [constructor](RTCDtlsTransport.md#constructor) +[werift](../globals.md) / RTCDtlsTransport -### Properties - -- [certificates](RTCDtlsTransport.md#certificates) -- [config](RTCDtlsTransport.md#config) -- [dataReceiver](RTCDtlsTransport.md#datareceiver) -- [dtls](RTCDtlsTransport.md#dtls) -- [iceTransport](RTCDtlsTransport.md#icetransport) -- [id](RTCDtlsTransport.md#id) -- [localCertificate](RTCDtlsTransport.md#localcertificate) -- [onStateChange](RTCDtlsTransport.md#onstatechange) -- [role](RTCDtlsTransport.md#role) -- [router](RTCDtlsTransport.md#router) -- [srtcp](RTCDtlsTransport.md#srtcp) -- [srtp](RTCDtlsTransport.md#srtp) -- [srtpStarted](RTCDtlsTransport.md#srtpstarted) -- [state](RTCDtlsTransport.md#state) -- [transportSequenceNumber](RTCDtlsTransport.md#transportsequencenumber) +# Class: RTCDtlsTransport -### Accessors +## Constructors -- [localParameters](RTCDtlsTransport.md#localparameters) +### new RTCDtlsTransport() -### Methods +> **new RTCDtlsTransport**(`config`, `iceTransport`, `router`, `certificates`, `srtpProfiles`): [`RTCDtlsTransport`](RTCDtlsTransport.md) -- [sendData](RTCDtlsTransport.md#senddata) -- [sendRtcp](RTCDtlsTransport.md#sendrtcp) -- [sendRtp](RTCDtlsTransport.md#sendrtp) -- [setRemoteParams](RTCDtlsTransport.md#setremoteparams) -- [setupCertificate](RTCDtlsTransport.md#setupcertificate) -- [start](RTCDtlsTransport.md#start) -- [startSrtp](RTCDtlsTransport.md#startsrtp) -- [stop](RTCDtlsTransport.md#stop) -- [updateSrtpSession](RTCDtlsTransport.md#updatesrtpsession) +#### Parameters -## Constructors +• **config**: [`PeerConfig`](../interfaces/PeerConfig.md) -### constructor +• **iceTransport**: [`RTCIceTransport`](RTCIceTransport.md) -• **new RTCDtlsTransport**(`config`, `iceTransport`, `router`, `certificates`, `srtpProfiles?`): [`RTCDtlsTransport`](RTCDtlsTransport.md) +• **router**: `RtpRouter` -#### Parameters +• **certificates**: [`RTCCertificate`](RTCCertificate.md)[] -| Name | Type | Default value | -| :------ | :------ | :------ | -| `config` | [`PeerConfig`](../interfaces/PeerConfig.md) | `undefined` | -| `iceTransport` | [`RTCIceTransport`](RTCIceTransport.md) | `undefined` | -| `router` | `RtpRouter` | `undefined` | -| `certificates` | [`RTCCertificate`](RTCCertificate.md)[] | `undefined` | -| `srtpProfiles` | (``1`` \| ``7``)[] | `[]` | +• **srtpProfiles**: (`1` \| `7`)[] = `[]` #### Returns @@ -66,111 +32,111 @@ ### certificates -• `Readonly` **certificates**: [`RTCCertificate`](RTCCertificate.md)[] +> `readonly` **certificates**: [`RTCCertificate`](RTCCertificate.md)[] -___ +*** ### config -• `Readonly` **config**: [`PeerConfig`](../interfaces/PeerConfig.md) +> `readonly` **config**: [`PeerConfig`](../interfaces/PeerConfig.md) -___ +*** -### dataReceiver +### dataReceiver() -• **dataReceiver**: (`buf`: `Buffer`) => `void` +> **dataReceiver**: (`buf`) => `void` -#### Type declaration - -▸ (`buf`): `void` - -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` -##### Returns +#### Returns `void` -___ +*** -### dtls +### dtls? -• `Optional` **dtls**: `DtlsSocket` +> `optional` **dtls**: `DtlsSocket` -___ +*** ### iceTransport -• `Readonly` **iceTransport**: [`RTCIceTransport`](RTCIceTransport.md) +> `readonly` **iceTransport**: [`RTCIceTransport`](RTCIceTransport.md) -___ +*** ### id -• **id**: `string` +> **id**: `string` -___ +*** -### localCertificate +### localCertificate? -• `Optional` **localCertificate**: [`RTCCertificate`](RTCCertificate.md) +> `optional` **localCertificate**: [`RTCCertificate`](RTCCertificate.md) -___ +*** + +### localCertificatePromise? + +> `optional` **localCertificatePromise**: `Promise`\<[`RTCCertificate`](RTCCertificate.md)\> + +*** ### onStateChange -• `Readonly` **onStateChange**: `Event`\<[``"closed"`` \| ``"new"`` \| ``"connected"`` \| ``"connecting"`` \| ``"failed"``]\> +> `readonly` **onStateChange**: [`Event`](Event.md)\<[`"closed"` \| `"new"` \| `"connected"` \| `"connecting"` \| `"failed"`]\> -___ +*** ### role -• **role**: [`DtlsRole`](../modules.md#dtlsrole) = `"auto"` +> **role**: [`DtlsRole`](../type-aliases/DtlsRole.md) = `"auto"` -___ +*** ### router -• `Readonly` **router**: `RtpRouter` +> `readonly` **router**: `RtpRouter` -___ +*** ### srtcp -• **srtcp**: [`SrtcpSession`](SrtcpSession.md) +> **srtcp**: [`SrtcpSession`](SrtcpSession.md) -___ +*** ### srtp -• **srtp**: [`SrtpSession`](SrtpSession.md) +> **srtp**: [`SrtpSession`](SrtpSession.md) -___ +*** ### srtpStarted -• **srtpStarted**: `boolean` = `false` +> **srtpStarted**: `boolean` = `false` -___ +*** ### state -• **state**: ``"closed"`` \| ``"new"`` \| ``"connected"`` \| ``"connecting"`` \| ``"failed"`` = `"new"` +> **state**: `"closed"` \| `"new"` \| `"connected"` \| `"connecting"` \| `"failed"` = `"new"` -___ +*** ### transportSequenceNumber -• **transportSequenceNumber**: `number` = `0` +> **transportSequenceNumber**: `number` = `0` ## Accessors ### localParameters -• `get` **localParameters**(): [`RTCDtlsParameters`](RTCDtlsParameters.md) +> `get` **localParameters**(): [`RTCDtlsParameters`](RTCDtlsParameters.md) #### Returns @@ -178,114 +144,107 @@ ___ ## Methods -### sendData +### sendData() -▸ **sendData**(`data`): `Promise`\<`void`\> +> `readonly` **sendData**(`data`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns `Promise`\<`void`\> -___ +*** -### sendRtcp +### sendRtcp() -▸ **sendRtcp**(`packets`): `Promise`\<`undefined` \| `number`\> +> **sendRtcp**(`packets`): `Promise`\<`undefined` \| `number`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `packets` | [`RtcpPacket`](../modules.md#rtcppacket)[] | +• **packets**: [`RtcpPacket`](../type-aliases/RtcpPacket.md)[] #### Returns `Promise`\<`undefined` \| `number`\> -___ +*** -### sendRtp +### sendRtp() -▸ **sendRtp**(`payload`, `header`): `Promise`\<`number`\> +> **sendRtp**(`payload`, `header`): `Promise`\<`number`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **payload**: `Buffer` + +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns `Promise`\<`number`\> -___ +*** -### setRemoteParams +### setRemoteParams() -▸ **setRemoteParams**(`remoteParameters`): `void` +> **setRemoteParams**(`remoteParameters`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `remoteParameters` | [`RTCDtlsParameters`](RTCDtlsParameters.md) | +• **remoteParameters**: [`RTCDtlsParameters`](RTCDtlsParameters.md) #### Returns `void` -___ +*** -### setupCertificate +### setupCertificate() -▸ **setupCertificate**(): `Promise`\<[`RTCCertificate`](RTCCertificate.md)\> +> **setupCertificate**(): `Promise`\<[`RTCCertificate`](RTCCertificate.md)\> #### Returns `Promise`\<[`RTCCertificate`](RTCCertificate.md)\> -___ +*** -### start +### start() -▸ **start**(): `Promise`\<`void`\> +> **start**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### startSrtp +### startSrtp() -▸ **startSrtp**(): `void` +> **startSrtp**(): `void` #### Returns `void` -___ +*** -### stop +### stop() -▸ **stop**(): `Promise`\<`void`\> +> **stop**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### updateSrtpSession +### updateSrtpSession() -▸ **updateSrtpSession**(): `void` +> **updateSrtpSession**(): `void` #### Returns diff --git a/doc/classes/RTCIceCandidate.md b/doc/classes/RTCIceCandidate.md index f72b66dd7..af68dd7c2 100644 --- a/doc/classes/RTCIceCandidate.md +++ b/doc/classes/RTCIceCandidate.md @@ -1,35 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCIceCandidate +[**werift**](../README.md) • **Docs** -# Class: RTCIceCandidate - -## Table of contents - -### Constructors - -- [constructor](RTCIceCandidate.md#constructor) - -### Properties - -- [candidate](RTCIceCandidate.md#candidate) -- [sdpMLineIndex](RTCIceCandidate.md#sdpmlineindex) -- [sdpMid](RTCIceCandidate.md#sdpmid) +*** -### Methods +[werift](../globals.md) / RTCIceCandidate -- [toJSON](RTCIceCandidate.md#tojson) -- [isThis](RTCIceCandidate.md#isthis) +# Class: RTCIceCandidate ## Constructors -### constructor +### new RTCIceCandidate() -• **new RTCIceCandidate**(`props`): [`RTCIceCandidate`](RTCIceCandidate.md) +> **new RTCIceCandidate**(`props`): [`RTCIceCandidate`](RTCIceCandidate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCIceCandidate`](RTCIceCandidate.md)\> | +• **props**: `Partial`\<[`RTCIceCandidate`](RTCIceCandidate.md)\> #### Returns @@ -39,48 +24,52 @@ ### candidate -• **candidate**: `string` +> **candidate**: `string` -___ +*** -### sdpMLineIndex +### sdpMLineIndex? -• `Optional` **sdpMLineIndex**: `number` +> `optional` **sdpMLineIndex**: `number` -___ +*** -### sdpMid +### sdpMid? -• `Optional` **sdpMid**: `string` +> `optional` **sdpMid**: `string` ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### candidate + +> **candidate**: `string` + +##### sdpMLineIndex + +> **sdpMLineIndex**: `undefined` \| `number` + +##### sdpMid -| Name | Type | -| :------ | :------ | -| `candidate` | `string` | -| `sdpMLineIndex` | `undefined` \| `number` | -| `sdpMid` | `undefined` \| `string` | +> **sdpMid**: `undefined` \| `string` -___ +*** -### isThis +### isThis() -▸ **isThis**(`o`): `undefined` \| ``true`` +> `static` **isThis**(`o`): `undefined` \| `true` #### Parameters -| Name | Type | -| :------ | :------ | -| `o` | `any` | +• **o**: `any` #### Returns -`undefined` \| ``true`` +`undefined` \| `true` diff --git a/doc/classes/RTCIceGatherer.md b/doc/classes/RTCIceGatherer.md index 34936bba5..4049df34c 100644 --- a/doc/classes/RTCIceGatherer.md +++ b/doc/classes/RTCIceGatherer.md @@ -1,40 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCIceGatherer +[**werift**](../README.md) • **Docs** -# Class: RTCIceGatherer - -## Table of contents - -### Constructors - -- [constructor](RTCIceGatherer.md#constructor) - -### Properties - -- [connection](RTCIceGatherer.md#connection) -- [gatheringState](RTCIceGatherer.md#gatheringstate) -- [onGatheringStateChange](RTCIceGatherer.md#ongatheringstatechange) -- [onIceCandidate](RTCIceGatherer.md#onicecandidate) - -### Accessors +*** -- [localCandidates](RTCIceGatherer.md#localcandidates) -- [localParameters](RTCIceGatherer.md#localparameters) +[werift](../globals.md) / RTCIceGatherer -### Methods - -- [gather](RTCIceGatherer.md#gather) +# Class: RTCIceGatherer ## Constructors -### constructor +### new RTCIceGatherer() -• **new RTCIceGatherer**(`options?`): [`RTCIceGatherer`](RTCIceGatherer.md) +> **new RTCIceGatherer**(`options`): [`RTCIceGatherer`](RTCIceGatherer.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `options` | `Partial`\<[`IceOptions`](../interfaces/IceOptions.md)\> | +• **options**: `Partial`\<[`IceOptions`](../interfaces/IceOptions.md)\> = `{}` #### Returns @@ -44,37 +24,31 @@ ### connection -• `Readonly` **connection**: [`Connection`](Connection.md) +> `readonly` **connection**: [`Connection`](Connection.md) -___ +*** ### gatheringState -• **gatheringState**: ``"new"`` \| ``"complete"`` \| ``"gathering"`` = `"new"` +> **gatheringState**: `"complete"` \| `"new"` \| `"gathering"` = `"new"` -___ +*** ### onGatheringStateChange -• `Readonly` **onGatheringStateChange**: `Event`\<[``"new"`` \| ``"complete"`` \| ``"gathering"``]\> - -___ +> `readonly` **onGatheringStateChange**: [`Event`](Event.md)\<[`"complete"` \| `"new"` \| `"gathering"`]\> -### onIceCandidate +*** -• **onIceCandidate**: (`candidate`: [`IceCandidate`](IceCandidate.md)) => `void` +### onIceCandidate() -#### Type declaration +> **onIceCandidate**: (`candidate`) => `void` -▸ (`candidate`): `void` - -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `candidate` | [`IceCandidate`](IceCandidate.md) | +• **candidate**: `undefined` \| [`IceCandidate`](IceCandidate.md) -##### Returns +#### Returns `void` @@ -82,17 +56,17 @@ ___ ### localCandidates -• `get` **localCandidates**(): [`IceCandidate`](IceCandidate.md)[] +> `get` **localCandidates**(): [`IceCandidate`](IceCandidate.md)[] #### Returns [`IceCandidate`](IceCandidate.md)[] -___ +*** ### localParameters -• `get` **localParameters**(): [`RTCIceParameters`](RTCIceParameters.md) +> `get` **localParameters**(): [`RTCIceParameters`](RTCIceParameters.md) #### Returns @@ -100,9 +74,9 @@ ___ ## Methods -### gather +### gather() -▸ **gather**(): `Promise`\<`void`\> +> **gather**(): `Promise`\<`void`\> #### Returns diff --git a/doc/classes/RTCIceParameters.md b/doc/classes/RTCIceParameters.md index dcb8063a1..f6b51adfa 100644 --- a/doc/classes/RTCIceParameters.md +++ b/doc/classes/RTCIceParameters.md @@ -1,30 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCIceParameters +[**werift**](../README.md) • **Docs** -# Class: RTCIceParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCIceParameters.md#constructor) +[werift](../globals.md) / RTCIceParameters -### Properties - -- [iceLite](RTCIceParameters.md#icelite) -- [password](RTCIceParameters.md#password) -- [usernameFragment](RTCIceParameters.md#usernamefragment) +# Class: RTCIceParameters ## Constructors -### constructor +### new RTCIceParameters() -• **new RTCIceParameters**(`props?`): [`RTCIceParameters`](RTCIceParameters.md) +> **new RTCIceParameters**(`props`): [`RTCIceParameters`](RTCIceParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCIceParameters`](RTCIceParameters.md)\> | +• **props**: `Partial`\<[`RTCIceParameters`](RTCIceParameters.md)\> = `{}` #### Returns @@ -34,16 +24,16 @@ ### iceLite -• **iceLite**: `boolean` = `false` +> **iceLite**: `boolean` = `false` -___ +*** ### password -• **password**: `string` +> **password**: `string` -___ +*** ### usernameFragment -• **usernameFragment**: `string` +> **usernameFragment**: `string` diff --git a/doc/classes/RTCIceTransport.md b/doc/classes/RTCIceTransport.md index 8b88b3296..f75c50be6 100644 --- a/doc/classes/RTCIceTransport.md +++ b/doc/classes/RTCIceTransport.md @@ -1,43 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCIceTransport +[**werift**](../README.md) • **Docs** -# Class: RTCIceTransport - -## Table of contents - -### Constructors - -- [constructor](RTCIceTransport.md#constructor) - -### Properties +*** -- [connection](RTCIceTransport.md#connection) -- [id](RTCIceTransport.md#id) -- [onStateChange](RTCIceTransport.md#onstatechange) -- [state](RTCIceTransport.md#state) +[werift](../globals.md) / RTCIceTransport -### Accessors - -- [iceGather](RTCIceTransport.md#icegather) -- [role](RTCIceTransport.md#role) - -### Methods - -- [addRemoteCandidate](RTCIceTransport.md#addremotecandidate) -- [setRemoteParams](RTCIceTransport.md#setremoteparams) -- [start](RTCIceTransport.md#start) -- [stop](RTCIceTransport.md#stop) +# Class: RTCIceTransport ## Constructors -### constructor +### new RTCIceTransport() -• **new RTCIceTransport**(`gather`): [`RTCIceTransport`](RTCIceTransport.md) +> **new RTCIceTransport**(`gather`): [`RTCIceTransport`](RTCIceTransport.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `gather` | [`RTCIceGatherer`](RTCIceGatherer.md) | +• **gather**: [`RTCIceGatherer`](RTCIceGatherer.md) #### Returns @@ -47,93 +24,89 @@ ### connection -• **connection**: [`Connection`](Connection.md) +> **connection**: [`Connection`](Connection.md) -___ +*** ### id -• `Readonly` **id**: `string` +> `readonly` **id**: `string` -___ +*** ### onStateChange -• `Readonly` **onStateChange**: `Event`\<[``"disconnected"`` \| ``"closed"`` \| ``"completed"`` \| ``"new"`` \| ``"connected"`` \| ``"failed"`` \| ``"checking"``]\> +> `readonly` **onStateChange**: [`Event`](Event.md)\<[`"disconnected"` \| `"closed"` \| `"completed"` \| `"new"` \| `"connected"` \| `"failed"` \| `"checking"`]\> -___ +*** ### state -• **state**: ``"disconnected"`` \| ``"closed"`` \| ``"completed"`` \| ``"new"`` \| ``"connected"`` \| ``"failed"`` \| ``"checking"`` = `"new"` +> **state**: `"disconnected"` \| `"closed"` \| `"completed"` \| `"new"` \| `"connected"` \| `"failed"` \| `"checking"` = `"new"` ## Accessors ### iceGather -• `get` **iceGather**(): [`RTCIceGatherer`](RTCIceGatherer.md) +> `get` **iceGather**(): [`RTCIceGatherer`](RTCIceGatherer.md) #### Returns [`RTCIceGatherer`](RTCIceGatherer.md) -___ +*** ### role -• `get` **role**(): ``"controlling"`` \| ``"controlled"`` +> `get` **role**(): `"controlling"` \| `"controlled"` #### Returns -``"controlling"`` \| ``"controlled"`` +`"controlling"` \| `"controlled"` ## Methods -### addRemoteCandidate +### addRemoteCandidate() -▸ **addRemoteCandidate**(`candidate?`): `undefined` \| `Promise`\<`void`\> +> **addRemoteCandidate**(`candidate`?): `undefined` \| `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `candidate?` | [`IceCandidate`](IceCandidate.md) | +• **candidate?**: [`IceCandidate`](IceCandidate.md) #### Returns `undefined` \| `Promise`\<`void`\> -___ +*** -### setRemoteParams +### setRemoteParams() -▸ **setRemoteParams**(`remoteParameters`): `void` +> **setRemoteParams**(`remoteParameters`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `remoteParameters` | [`RTCIceParameters`](RTCIceParameters.md) | +• **remoteParameters**: [`RTCIceParameters`](RTCIceParameters.md) #### Returns `void` -___ +*** -### start +### start() -▸ **start**(): `Promise`\<`void`\> +> **start**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### stop +### stop() -▸ **stop**(): `Promise`\<`void`\> +> **stop**(): `Promise`\<`void`\> #### Returns diff --git a/doc/classes/RTCPeerConnection.md b/doc/classes/RTCPeerConnection.md index 0df8520f0..e20db8fee 100644 --- a/doc/classes/RTCPeerConnection.md +++ b/doc/classes/RTCPeerConnection.md @@ -1,116 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCPeerConnection +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCPeerConnection # Class: RTCPeerConnection -## Hierarchy +## Extends - `EventTarget` - ↳ **`RTCPeerConnection`** - -## Table of contents - -### Constructors - -- [constructor](RTCPeerConnection.md#constructor) - -### Properties - -- [candidatesSent](RTCPeerConnection.md#candidatessent) -- [cname](RTCPeerConnection.md#cname) -- [config](RTCPeerConnection.md#config) -- [connectionState](RTCPeerConnection.md#connectionstate) -- [connectionStateChange](RTCPeerConnection.md#connectionstatechange) -- [iceConnectionState](RTCPeerConnection.md#iceconnectionstate) -- [iceConnectionStateChange](RTCPeerConnection.md#iceconnectionstatechange) -- [iceGatheringState](RTCPeerConnection.md#icegatheringstate) -- [iceGatheringStateChange](RTCPeerConnection.md#icegatheringstatechange) -- [negotiationneeded](RTCPeerConnection.md#negotiationneeded) -- [onDataChannel](RTCPeerConnection.md#ondatachannel) -- [onIceCandidate](RTCPeerConnection.md#onicecandidate) -- [onNegotiationneeded](RTCPeerConnection.md#onnegotiationneeded) -- [onRemoteTransceiverAdded](RTCPeerConnection.md#onremotetransceiveradded) -- [onTrack](RTCPeerConnection.md#ontrack) -- [onTransceiverAdded](RTCPeerConnection.md#ontransceiveradded) -- [onconnectionstatechange](RTCPeerConnection.md#onconnectionstatechange) -- [ondatachannel](RTCPeerConnection.md#ondatachannel-1) -- [onicecandidate](RTCPeerConnection.md#onicecandidate-1) -- [onnegotiationneeded](RTCPeerConnection.md#onnegotiationneeded-1) -- [onsignalingstatechange](RTCPeerConnection.md#onsignalingstatechange) -- [ontrack](RTCPeerConnection.md#ontrack-1) -- [sctpRemotePort](RTCPeerConnection.md#sctpremoteport) -- [sctpTransport](RTCPeerConnection.md#sctptransport) -- [signalingState](RTCPeerConnection.md#signalingstate) -- [signalingStateChange](RTCPeerConnection.md#signalingstatechange) -- [transportEstablished](RTCPeerConnection.md#transportestablished) -- [captureRejectionSymbol](RTCPeerConnection.md#capturerejectionsymbol) -- [captureRejections](RTCPeerConnection.md#capturerejections) -- [defaultMaxListeners](RTCPeerConnection.md#defaultmaxlisteners) -- [errorMonitor](RTCPeerConnection.md#errormonitor) - -### Accessors - -- [dtlsTransports](RTCPeerConnection.md#dtlstransports) -- [extIdUriMap](RTCPeerConnection.md#extidurimap) -- [iceTransports](RTCPeerConnection.md#icetransports) -- [localDescription](RTCPeerConnection.md#localdescription) -- [remoteDescription](RTCPeerConnection.md#remotedescription) -- [remoteIsBundled](RTCPeerConnection.md#remoteisbundled) - -### Methods - -- [[captureRejectionSymbol]](RTCPeerConnection.md#[capturerejectionsymbol]) -- [addEventListener](RTCPeerConnection.md#addeventlistener) -- [addIceCandidate](RTCPeerConnection.md#addicecandidate) -- [addListener](RTCPeerConnection.md#addlistener) -- [addTrack](RTCPeerConnection.md#addtrack) -- [addTransceiver](RTCPeerConnection.md#addtransceiver) -- [buildOfferSdp](RTCPeerConnection.md#buildoffersdp) -- [close](RTCPeerConnection.md#close) -- [createAnswer](RTCPeerConnection.md#createanswer) -- [createDataChannel](RTCPeerConnection.md#createdatachannel) -- [createOffer](RTCPeerConnection.md#createoffer) -- [emit](RTCPeerConnection.md#emit) -- [eventNames](RTCPeerConnection.md#eventnames) -- [getConfiguration](RTCPeerConnection.md#getconfiguration) -- [getMaxListeners](RTCPeerConnection.md#getmaxlisteners) -- [getReceivers](RTCPeerConnection.md#getreceivers) -- [getSenders](RTCPeerConnection.md#getsenders) -- [getTransceivers](RTCPeerConnection.md#gettransceivers) -- [listenerCount](RTCPeerConnection.md#listenercount) -- [listeners](RTCPeerConnection.md#listeners) -- [off](RTCPeerConnection.md#off) -- [on](RTCPeerConnection.md#on) -- [once](RTCPeerConnection.md#once) -- [prependListener](RTCPeerConnection.md#prependlistener) -- [prependOnceListener](RTCPeerConnection.md#prependoncelistener) -- [rawListeners](RTCPeerConnection.md#rawlisteners) -- [removeAllListeners](RTCPeerConnection.md#removealllisteners) -- [removeEventListener](RTCPeerConnection.md#removeeventlistener) -- [removeListener](RTCPeerConnection.md#removelistener) -- [removeTrack](RTCPeerConnection.md#removetrack) -- [setLocalDescription](RTCPeerConnection.md#setlocaldescription) -- [setMaxListeners](RTCPeerConnection.md#setmaxlisteners) -- [setRemoteDescription](RTCPeerConnection.md#setremotedescription) -- [addAbortListener](RTCPeerConnection.md#addabortlistener) -- [getEventListeners](RTCPeerConnection.md#geteventlisteners) -- [getMaxListeners](RTCPeerConnection.md#getmaxlisteners-1) -- [listenerCount](RTCPeerConnection.md#listenercount-1) -- [on](RTCPeerConnection.md#on-1) -- [once](RTCPeerConnection.md#once-1) -- [setMaxListeners](RTCPeerConnection.md#setmaxlisteners-1) - ## Constructors -### constructor +### new RTCPeerConnection() -• **new RTCPeerConnection**(`config?`): [`RTCPeerConnection`](RTCPeerConnection.md) +> **new RTCPeerConnection**(`config`): [`RTCPeerConnection`](RTCPeerConnection.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | `Partial`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> | +• **config**: `Partial`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> = `{}` #### Returns @@ -118,207 +26,207 @@ #### Overrides -EventTarget.constructor +`EventTarget.constructor` ## Properties ### candidatesSent -• **candidatesSent**: `Set`\<`string`\> +> **candidatesSent**: `Set`\<`string`\> -___ +*** ### cname -• `Readonly` **cname**: `string` +> `readonly` **cname**: `string` -___ +*** ### config -• **config**: `Required`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> +> **config**: `Required`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> -___ +*** ### connectionState -• **connectionState**: ``"disconnected"`` \| ``"closed"`` \| ``"new"`` \| ``"connected"`` \| ``"connecting"`` \| ``"failed"`` = `"new"` +> **connectionState**: `"disconnected"` \| `"closed"` \| `"new"` \| `"connected"` \| `"connecting"` \| `"failed"` = `"new"` -___ +*** ### connectionStateChange -• `Readonly` **connectionStateChange**: `Event`\<[``"disconnected"`` \| ``"closed"`` \| ``"new"`` \| ``"connected"`` \| ``"connecting"`` \| ``"failed"``]\> +> `readonly` **connectionStateChange**: [`Event`](Event.md)\<[`"disconnected"` \| `"closed"` \| `"new"` \| `"connected"` \| `"connecting"` \| `"failed"`]\> -___ +*** ### iceConnectionState -• **iceConnectionState**: ``"disconnected"`` \| ``"closed"`` \| ``"completed"`` \| ``"new"`` \| ``"connected"`` \| ``"failed"`` \| ``"checking"`` = `"new"` +> **iceConnectionState**: `"disconnected"` \| `"closed"` \| `"completed"` \| `"new"` \| `"connected"` \| `"failed"` \| `"checking"` = `"new"` -___ +*** ### iceConnectionStateChange -• `Readonly` **iceConnectionStateChange**: `Event`\<[``"disconnected"`` \| ``"closed"`` \| ``"completed"`` \| ``"new"`` \| ``"connected"`` \| ``"failed"`` \| ``"checking"``]\> +> `readonly` **iceConnectionStateChange**: [`Event`](Event.md)\<[`"disconnected"` \| `"closed"` \| `"completed"` \| `"new"` \| `"connected"` \| `"failed"` \| `"checking"`]\> -___ +*** ### iceGatheringState -• **iceGatheringState**: ``"new"`` \| ``"complete"`` \| ``"gathering"`` = `"new"` +> **iceGatheringState**: `"complete"` \| `"new"` \| `"gathering"` = `"new"` -___ +*** ### iceGatheringStateChange -• `Readonly` **iceGatheringStateChange**: `Event`\<[``"new"`` \| ``"complete"`` \| ``"gathering"``]\> +> `readonly` **iceGatheringStateChange**: [`Event`](Event.md)\<[`"complete"` \| `"new"` \| `"gathering"`]\> -___ +*** ### negotiationneeded -• **negotiationneeded**: `boolean` = `false` +> **negotiationneeded**: `boolean` = `false` -___ +*** ### onDataChannel -• `Readonly` **onDataChannel**: `Event`\<[[`RTCDataChannel`](RTCDataChannel.md)]\> +> `readonly` **onDataChannel**: [`Event`](Event.md)\<[[`RTCDataChannel`](RTCDataChannel.md)]\> -___ +*** ### onIceCandidate -• `Readonly` **onIceCandidate**: `Event`\<[[`RTCIceCandidate`](RTCIceCandidate.md)]\> +> `readonly` **onIceCandidate**: [`Event`](Event.md)\<[`undefined` \| [`RTCIceCandidate`](RTCIceCandidate.md)]\> -___ +*** ### onNegotiationneeded -• `Readonly` **onNegotiationneeded**: `Event`\<[]\> +> `readonly` **onNegotiationneeded**: [`Event`](Event.md)\<[]\> -___ +*** ### onRemoteTransceiverAdded -• `Readonly` **onRemoteTransceiverAdded**: `Event`\<[[`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> +> `readonly` **onRemoteTransceiverAdded**: [`Event`](Event.md)\<[[`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> -___ +*** ### onTrack -• `Readonly` **onTrack**: `Event`\<[[`MediaStreamTrack`](MediaStreamTrack.md)]\> +> `readonly` **onTrack**: [`Event`](Event.md)\<[[`MediaStreamTrack`](MediaStreamTrack.md)]\> -___ +*** ### onTransceiverAdded -• `Readonly` **onTransceiverAdded**: `Event`\<[[`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> +> `readonly` **onTransceiverAdded**: [`Event`](Event.md)\<[[`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> -___ +*** -### onconnectionstatechange +### onconnectionstatechange? -• `Optional` **onconnectionstatechange**: `Callback` +> `optional` **onconnectionstatechange**: `Callback` -___ +*** -### ondatachannel +### ondatachannel? -• `Optional` **ondatachannel**: `CallbackWithValue`\<[`RTCDataChannelEvent`](../interfaces/RTCDataChannelEvent.md)\> +> `optional` **ondatachannel**: `CallbackWithValue`\<[`RTCDataChannelEvent`](../interfaces/RTCDataChannelEvent.md)\> -___ +*** -### onicecandidate +### onicecandidate? -• `Optional` **onicecandidate**: `CallbackWithValue`\<[`RTCPeerConnectionIceEvent`](../interfaces/RTCPeerConnectionIceEvent.md)\> +> `optional` **onicecandidate**: `CallbackWithValue`\<[`RTCPeerConnectionIceEvent`](../interfaces/RTCPeerConnectionIceEvent.md)\> -___ +*** -### onnegotiationneeded +### onnegotiationneeded? -• `Optional` **onnegotiationneeded**: `CallbackWithValue`\<`any`\> +> `optional` **onnegotiationneeded**: `CallbackWithValue`\<`any`\> -___ +*** -### onsignalingstatechange +### onsignalingstatechange? -• `Optional` **onsignalingstatechange**: `CallbackWithValue`\<`any`\> +> `optional` **onsignalingstatechange**: `CallbackWithValue`\<`any`\> -___ +*** -### ontrack +### ontrack? -• `Optional` **ontrack**: `CallbackWithValue`\<[`RTCTrackEvent`](../interfaces/RTCTrackEvent.md)\> +> `optional` **ontrack**: `CallbackWithValue`\<[`RTCTrackEvent`](../interfaces/RTCTrackEvent.md)\> -___ +*** -### sctpRemotePort +### sctpRemotePort? -• `Optional` **sctpRemotePort**: `number` +> `optional` **sctpRemotePort**: `number` -___ +*** -### sctpTransport +### sctpTransport? -• `Optional` **sctpTransport**: [`RTCSctpTransport`](RTCSctpTransport.md) +> `optional` **sctpTransport**: [`RTCSctpTransport`](RTCSctpTransport.md) -___ +*** ### signalingState -• **signalingState**: ``"closed"`` \| ``"stable"`` \| ``"have-local-offer"`` \| ``"have-remote-offer"`` \| ``"have-local-pranswer"`` \| ``"have-remote-pranswer"`` = `"stable"` +> **signalingState**: `"closed"` \| `"stable"` \| `"have-local-offer"` \| `"have-remote-offer"` \| `"have-local-pranswer"` \| `"have-remote-pranswer"` = `"stable"` -___ +*** ### signalingStateChange -• `Readonly` **signalingStateChange**: `Event`\<[``"closed"`` \| ``"stable"`` \| ``"have-local-offer"`` \| ``"have-remote-offer"`` \| ``"have-local-pranswer"`` \| ``"have-remote-pranswer"``]\> +> `readonly` **signalingStateChange**: [`Event`](Event.md)\<[`"closed"` \| `"stable"` \| `"have-local-offer"` \| `"have-remote-offer"` \| `"have-local-pranswer"` \| `"have-remote-pranswer"`]\> -___ +*** ### transportEstablished -• **transportEstablished**: `boolean` = `false` +> **transportEstablished**: `boolean` = `false` -___ +*** ### captureRejectionSymbol -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) +> `readonly` `static` **captureRejectionSymbol**: *typeof* [`captureRejectionSymbol`](RTCDataChannel.md#capturerejectionsymbol) #### Inherited from -EventTarget.captureRejectionSymbol +`EventTarget.captureRejectionSymbol` -___ +*** ### captureRejections -▪ `Static` **captureRejections**: `boolean` +> `static` **captureRejections**: `boolean` Sets or gets the default captureRejection value for all emitters. #### Inherited from -EventTarget.captureRejections +`EventTarget.captureRejections` -___ +*** ### defaultMaxListeners -▪ `Static` **defaultMaxListeners**: `number` +> `static` **defaultMaxListeners**: `number` #### Inherited from -EventTarget.defaultMaxListeners +`EventTarget.defaultMaxListeners` -___ +*** ### errorMonitor -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](RTCDataChannel.md#errormonitor) +> `readonly` `static` **errorMonitor**: *typeof* [`errorMonitor`](RTCDataChannel.md#errormonitor) This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular @@ -330,63 +238,63 @@ regular `'error'` listener is installed. #### Inherited from -EventTarget.errorMonitor +`EventTarget.errorMonitor` ## Accessors ### dtlsTransports -• `get` **dtlsTransports**(): [`RTCDtlsTransport`](RTCDtlsTransport.md)[] +> `get` **dtlsTransports**(): [`RTCDtlsTransport`](RTCDtlsTransport.md)[] #### Returns [`RTCDtlsTransport`](RTCDtlsTransport.md)[] -___ +*** ### extIdUriMap -• `get` **extIdUriMap**(): `Object` +> `get` **extIdUriMap**(): `object` #### Returns -`Object` +`object` -___ +*** ### iceTransports -• `get` **iceTransports**(): [`RTCIceTransport`](RTCIceTransport.md)[] +> `get` **iceTransports**(): [`RTCIceTransport`](RTCIceTransport.md)[] #### Returns [`RTCIceTransport`](RTCIceTransport.md)[] -___ +*** ### localDescription -• `get` **localDescription**(): `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) +> `get` **localDescription**(): `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) #### Returns `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) -___ +*** ### remoteDescription -• `get` **remoteDescription**(): `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) +> `get` **remoteDescription**(): `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) #### Returns `undefined` \| [`RTCSessionDescription`](RTCSessionDescription.md) -___ +*** ### remoteIsBundled -• `get` **remoteIsBundled**(): `undefined` \| [`GroupDescription`](GroupDescription.md) +> `get` **remoteIsBundled**(): `undefined` \| [`GroupDescription`](GroupDescription.md) #### Returns @@ -394,17 +302,17 @@ ___ ## Methods -### [captureRejectionSymbol] +### \[captureRejectionSymbol\]()? -▸ **[captureRejectionSymbol]**(`error`, `event`, `...args`): `void` +> `optional` **\[captureRejectionSymbol\]**(`error`, `event`, ...`args`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `error` | `Error` | -| `event` | `string` | -| `...args` | `any`[] | +• **error**: `Error` + +• **event**: `string` + +• ...**args**: `any`[] #### Returns @@ -412,20 +320,19 @@ ___ #### Inherited from -EventTarget.[captureRejectionSymbol] +`EventTarget.[captureRejectionSymbol]` -___ +*** -### addEventListener +### addEventListener() -▸ **addEventListener**(`type`, `listener`): `void` +> **addEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -433,147 +340,143 @@ ___ #### Inherited from -EventTarget.addEventListener +`EventTarget.addEventListener` -___ +*** -### addIceCandidate +### addIceCandidate() -▸ **addIceCandidate**(`candidateMessage`): `Promise`\<`void`\> +> **addIceCandidate**(`candidateMessage`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `candidateMessage` | [`RTCIceCandidate`](RTCIceCandidate.md) | +• **candidateMessage**: [`RTCIceCandidate`](RTCIceCandidate.md) #### Returns `Promise`\<`void`\> -___ +*** -### addListener +### addListener() -▸ **addListener**(`eventName`, `listener`): `this` +> **addListener**(`eventName`, `listener`): `this` Alias for `emitter.on(eventName, listener)`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.addListener +`EventTarget.addListener` -___ +*** -### addTrack +### addTrack() -▸ **addTrack**(`track`, `ms?`): [`RTCRtpSender`](RTCRtpSender.md) +> **addTrack**(`track`, `ms`?): [`RTCRtpSender`](RTCRtpSender.md) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `track` | [`MediaStreamTrack`](MediaStreamTrack.md) | - | -| `ms?` | [`MediaStream`](MediaStream.md) | todo impl | +• **track**: [`MediaStreamTrack`](MediaStreamTrack.md) + +• **ms?**: [`MediaStream`](MediaStream.md) + +todo impl #### Returns [`RTCRtpSender`](RTCRtpSender.md) -___ +*** -### addTransceiver +### addTransceiver() -▸ **addTransceiver**(`trackOrKind`, `options?`): [`RTCRtpTransceiver`](RTCRtpTransceiver.md) +> **addTransceiver**(`trackOrKind`, `options`): [`RTCRtpTransceiver`](RTCRtpTransceiver.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `trackOrKind` | ``"unknown"`` \| ``"audio"`` \| ``"video"`` \| ``"application"`` \| [`MediaStreamTrack`](MediaStreamTrack.md) | -| `options` | `Partial`\<[`TransceiverOptions`](../interfaces/TransceiverOptions.md)\> | +• **trackOrKind**: [`Kind`](../type-aliases/Kind.md) \| [`MediaStreamTrack`](MediaStreamTrack.md) + +• **options**: `Partial`\<[`TransceiverOptions`](../interfaces/TransceiverOptions.md)\> = `{}` #### Returns [`RTCRtpTransceiver`](RTCRtpTransceiver.md) -___ +*** -### buildOfferSdp +### buildOfferSdp() -▸ **buildOfferSdp**(): [`SessionDescription`](SessionDescription.md) +> **buildOfferSdp**(): [`SessionDescription`](SessionDescription.md) #### Returns [`SessionDescription`](SessionDescription.md) -___ +*** -### close +### close() -▸ **close**(): `Promise`\<`void`\> +> **close**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### createAnswer +### createAnswer() -▸ **createAnswer**(): `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> +> **createAnswer**(): `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> #### Returns `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> -___ +*** -### createDataChannel +### createDataChannel() -▸ **createDataChannel**(`label`, `options?`): [`RTCDataChannel`](RTCDataChannel.md) +> **createDataChannel**(`label`, `options`): [`RTCDataChannel`](RTCDataChannel.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `label` | `string` | -| `options` | `Partial`\<\{ `id?`: `number` ; `maxPacketLifeTime?`: `number` ; `maxRetransmits?`: `number` ; `negotiated`: `boolean` ; `ordered`: `boolean` ; `protocol`: `string` }\> | +• **label**: `string` + +• **options**: `Partial`\<`object`\> = `{}` #### Returns [`RTCDataChannel`](RTCDataChannel.md) -___ +*** -### createOffer +### createOffer() -▸ **createOffer**(): `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> +> **createOffer**(): `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> #### Returns `Promise`\<[`RTCSessionDescription`](RTCSessionDescription.md)\> -___ +*** -### emit +### emit() -▸ **emit**(`eventName`, `...args`): `boolean` +> **emit**(`eventName`, ...`args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -615,28 +518,27 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | +• **eventName**: `string` \| `symbol` + +• ...**args**: `any`[] #### Returns `boolean` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.emit +`EventTarget.emit` -___ +*** -### eventNames +### eventNames() -▸ **eventNames**(): (`string` \| `symbol`)[] +> **eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -658,29 +560,29 @@ console.log(myEE.eventNames()); (`string` \| `symbol`)[] -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.eventNames +`EventTarget.eventNames` -___ +*** -### getConfiguration +### getConfiguration() -▸ **getConfiguration**(): [`PeerConfig`](../interfaces/PeerConfig.md) +> **getConfiguration**(): `Required`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> #### Returns -[`PeerConfig`](../interfaces/PeerConfig.md) +`Required`\<[`PeerConfig`](../interfaces/PeerConfig.md)\> -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(): `number` +> **getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](RTCPeerConnection.md#defaultmaxlisteners). @@ -689,49 +591,49 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](RTCPeer `number` -**`Since`** +#### Since v1.0.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### getReceivers +### getReceivers() -▸ **getReceivers**(): [`RTCRtpReceiver`](RTCRtpReceiver.md)[] +> **getReceivers**(): [`RTCRtpReceiver`](RTCRtpReceiver.md)[] #### Returns [`RTCRtpReceiver`](RTCRtpReceiver.md)[] -___ +*** -### getSenders +### getSenders() -▸ **getSenders**(): [`RTCRtpSender`](RTCRtpSender.md)[] +> **getSenders**(): [`RTCRtpSender`](RTCRtpSender.md)[] #### Returns [`RTCRtpSender`](RTCRtpSender.md)[] -___ +*** -### getTransceivers +### getTransceivers() -▸ **getTransceivers**(): [`RTCRtpTransceiver`](RTCRtpTransceiver.md)[] +> **getTransceivers**(): [`RTCRtpTransceiver`](RTCRtpTransceiver.md)[] #### Returns [`RTCRtpTransceiver`](RTCRtpTransceiver.md)[] -___ +*** -### listenerCount +### listenerCount() -▸ **listenerCount**(`eventName`, `listener?`): `number` +> **listenerCount**(`eventName`, `listener`?): `number` Returns the number of listeners listening to the event named `eventName`. @@ -740,28 +642,31 @@ is found in the list of the listeners of the event. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | -| `listener?` | `Function` | The event handler function | +• **eventName**: `string` \| `symbol` + +The name of the event being listened for + +• **listener?**: `Function` + +The event handler function #### Returns `number` -**`Since`** +#### Since v3.2.0 #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### listeners +### listeners() -▸ **listeners**(`eventName`): `Function`[] +> **listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -775,54 +680,51 @@ console.log(util.inspect(server.listeners('connection'))); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.listeners +`EventTarget.listeners` -___ +*** -### off +### off() -▸ **off**(`eventName`, `listener`): `this` +> **off**(`eventName`, `listener`): `this` Alias for `emitter.removeListener()`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v10.0.0 #### Inherited from -EventTarget.off +`EventTarget.off` -___ +*** -### on +### on() -▸ **on**(`eventName`, `listener`): `this` +> **on**(`eventName`, `listener`): `this` Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -852,28 +754,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.1.101 #### Inherited from -EventTarget.on +`EventTarget.on` -___ +*** -### once +### once() -▸ **once**(`eventName`, `listener`): `this` +> **once**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -901,28 +806,31 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v0.3.0 #### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### prependListener +### prependListener() -▸ **prependListener**(`eventName`, `listener`): `this` +> **prependListener**(`eventName`, `listener`): `this` Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -939,28 +847,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependListener +`EventTarget.prependListener` -___ +*** -### prependOnceListener +### prependOnceListener() -▸ **prependOnceListener**(`eventName`, `listener`): `this` +> **prependOnceListener**(`eventName`, `listener`): `this` Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -975,28 +886,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | +• **eventName**: `string` \| `symbol` + +The name of the event. + +• **listener** + +The callback function #### Returns `this` -**`Since`** +#### Since v6.0.0 #### Inherited from -EventTarget.prependOnceListener +`EventTarget.prependOnceListener` -___ +*** -### rawListeners +### rawListeners() -▸ **rawListeners**(`eventName`): `Function`[] +> **rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -1027,27 +941,25 @@ emitter.emit('log'); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | +• **eventName**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v9.4.0 #### Inherited from -EventTarget.rawListeners +`EventTarget.rawListeners` -___ +*** -### removeAllListeners +### removeAllListeners() -▸ **removeAllListeners**(`event?`): `this` +> **removeAllListeners**(`event`?): `this` Removes all listeners, or those of the specified `eventName`. @@ -1059,34 +971,31 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | +• **event?**: `string` \| `symbol` #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeAllListeners +`EventTarget.removeAllListeners` -___ +*** -### removeEventListener +### removeEventListener() -▸ **removeEventListener**(`type`, `listener`): `void` +> **removeEventListener**(`type`, `listener`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | +• **type**: `string` + +• **listener** #### Returns @@ -1094,13 +1003,13 @@ ___ #### Inherited from -EventTarget.removeEventListener +`EventTarget.removeEventListener` -___ +*** -### removeListener +### removeListener() -▸ **removeListener**(`eventName`, `listener`): `this` +> **removeListener**(`eventName`, `listener`): `this` Removes the specified `listener` from the listener array for the event named`eventName`. @@ -1181,62 +1090,59 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | +• **eventName**: `string` \| `symbol` + +• **listener** #### Returns `this` -**`Since`** +#### Since v0.1.26 #### Inherited from -EventTarget.removeListener +`EventTarget.removeListener` -___ +*** -### removeTrack +### removeTrack() -▸ **removeTrack**(`sender`): `void` +> **removeTrack**(`sender`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `sender` | [`RTCRtpSender`](RTCRtpSender.md) | +• **sender**: [`RTCRtpSender`](RTCRtpSender.md) #### Returns `void` -___ +*** -### setLocalDescription +### setLocalDescription() -▸ **setLocalDescription**(`sessionDescription`): `Promise`\<[`SessionDescription`](SessionDescription.md)\> +> **setLocalDescription**(`sessionDescription`): `Promise`\<[`SessionDescription`](SessionDescription.md)\> #### Parameters -| Name | Type | -| :------ | :------ | -| `sessionDescription` | `Object` | -| `sessionDescription.sdp` | `string` | -| `sessionDescription.type` | ``"offer"`` \| ``"answer"`` | +• **sessionDescription** + +• **sessionDescription.sdp**: `string` + +• **sessionDescription.type**: `"offer"` \| `"answer"` #### Returns `Promise`\<[`SessionDescription`](SessionDescription.md)\> -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n`): `this` +> **setMaxListeners**(`n`): `this` By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -1247,43 +1153,41 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `n` | `number` | +• **n**: `number` #### Returns `this` -**`Since`** +#### Since v0.3.5 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` -___ +*** -### setRemoteDescription +### setRemoteDescription() -▸ **setRemoteDescription**(`sessionDescription`): `Promise`\<`void`\> +> **setRemoteDescription**(`sessionDescription`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `sessionDescription` | [`RTCSessionDescriptionInit`](../interfaces/RTCSessionDescriptionInit.md) | +• **sessionDescription**: [`RTCSessionDescriptionInit`](../interfaces/RTCSessionDescriptionInit.md) #### Returns `Promise`\<`void`\> -___ +*** -### addAbortListener +### addAbortListener() -▸ **addAbortListener**(`signal`, `resource`): `Disposable` +> `static` **addAbortListener**(`signal`, `resource`): `Disposable` + +**`Experimental`** Listens once to the `abort` event on the provided `signal`. @@ -1317,10 +1221,9 @@ function example(signal) { #### Parameters -| Name | Type | -| :------ | :------ | -| `signal` | `AbortSignal` | -| `resource` | (`event`: `Event`) => `void` | +• **signal**: `AbortSignal` + +• **resource** #### Returns @@ -1328,19 +1231,19 @@ function example(signal) { Disposable that removes the `abort` listener. -**`Since`** +#### Since v18.18.0 #### Inherited from -EventTarget.addAbortListener +`EventTarget.addAbortListener` -___ +*** -### getEventListeners +### getEventListeners() -▸ **getEventListeners**(`emitter`, `name`): `Function`[] +> `static` **getEventListeners**(`emitter`, `name`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1369,28 +1272,27 @@ const { getEventListeners, EventEmitter } = require('events'); #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | -| `name` | `string` \| `symbol` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` + +• **name**: `string` \| `symbol` #### Returns `Function`[] -**`Since`** +#### Since v15.2.0, v14.17.0 #### Inherited from -EventTarget.getEventListeners +`EventTarget.getEventListeners` -___ +*** -### getMaxListeners +### getMaxListeners() -▸ **getMaxListeners**(`emitter`): `number` +> `static` **getMaxListeners**(`emitter`): `number` Returns the currently set max amount of listeners. @@ -1420,27 +1322,25 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; #### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| `_DOMEventTarget` | +• **emitter**: `EventEmitter` \| `_DOMEventTarget` #### Returns `number` -**`Since`** +#### Since v18.17.0 #### Inherited from -EventTarget.getMaxListeners +`EventTarget.getMaxListeners` -___ +*** -### listenerCount +### ~~listenerCount()~~ -▸ **listenerCount**(`emitter`, `eventName`): `number` +> `static` **listenerCount**(`emitter`, `eventName`): `number` A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. @@ -1455,32 +1355,35 @@ console.log(listenerCount(myEmitter, 'event')); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | +• **emitter**: `EventEmitter` + +The emitter to query + +• **eventName**: `string` \| `symbol` + +The event name #### Returns `number` -**`Since`** +#### Since v0.9.12 -**`Deprecated`** +#### Deprecated Since v3.2.0 - Use `listenerCount` instead. #### Inherited from -EventTarget.listenerCount +`EventTarget.listenerCount` -___ +*** -### on +### on() -▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`\<`any`\> +> `static` **on**(`emitter`, `eventName`, `options`?): `AsyncIterableIterator`\<`any`\> ```js const { on, EventEmitter } = require('events'); @@ -1538,11 +1441,13 @@ process.nextTick(() => ac.abort()); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | `StaticEventEmitterOptions` | - | +• **emitter**: `EventEmitter` + +• **eventName**: `string` + +The name of the event being listened for + +• **options?**: `StaticEventEmitterOptions` #### Returns @@ -1550,19 +1455,21 @@ process.nextTick(() => ac.abort()); that iterates `eventName` events emitted by the `emitter` -**`Since`** +#### Since v13.6.0, v12.16.0 #### Inherited from -EventTarget.on +`EventTarget.on` + +*** -___ +### once() -### once +#### once(emitter, eventName, options) -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1644,49 +1551,51 @@ ac.abort(); // Abort waiting for the event ee.emit('foo'); // Prints: Waiting for the event was canceled! ``` -#### Parameters +##### Parameters -| Name | Type | -| :------ | :------ | -| `emitter` | `_NodeEventTarget` | -| `eventName` | `string` \| `symbol` | -| `options?` | `StaticEventEmitterOptions` | +• **emitter**: `_NodeEventTarget` -#### Returns +• **eventName**: `string` \| `symbol` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -**`Since`** +##### Since v11.13.0, v10.16.0 -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -▸ **once**(`emitter`, `eventName`, `options?`): `Promise`\<`any`[]\> +#### once(emitter, eventName, options) -#### Parameters +> `static` **once**(`emitter`, `eventName`, `options`?): `Promise`\<`any`[]\> -| Name | Type | -| :------ | :------ | -| `emitter` | `_DOMEventTarget` | -| `eventName` | `string` | -| `options?` | `StaticEventEmitterOptions` | +##### Parameters -#### Returns +• **emitter**: `_DOMEventTarget` + +• **eventName**: `string` + +• **options?**: `StaticEventEmitterOptions` + +##### Returns `Promise`\<`any`[]\> -#### Inherited from +##### Inherited from -EventTarget.once +`EventTarget.once` -___ +*** -### setMaxListeners +### setMaxListeners() -▸ **setMaxListeners**(`n?`, `...eventTargets`): `void` +> `static` **setMaxListeners**(`n`?, ...`eventTargets`?): `void` ```js const { @@ -1702,19 +1611,20 @@ setMaxListeners(5, target, emitter); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | -| `...eventTargets` | (`EventEmitter` \| `_DOMEventTarget`)[] | - | +• **n?**: `number` + +A non-negative number. The maximum number of listeners per `EventTarget` event. + +• ...**eventTargets?**: (`EventEmitter` \| `_DOMEventTarget`)[] #### Returns `void` -**`Since`** +#### Since v15.4.0 #### Inherited from -EventTarget.setMaxListeners +`EventTarget.setMaxListeners` diff --git a/doc/classes/RTCRtcpFeedback.md b/doc/classes/RTCRtcpFeedback.md index 11c3191db..084483566 100644 --- a/doc/classes/RTCRtcpFeedback.md +++ b/doc/classes/RTCRtcpFeedback.md @@ -1,29 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtcpFeedback +[**werift**](../README.md) • **Docs** -# Class: RTCRtcpFeedback - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtcpFeedback.md#constructor) +[werift](../globals.md) / RTCRtcpFeedback -### Properties - -- [parameter](RTCRtcpFeedback.md#parameter) -- [type](RTCRtcpFeedback.md#type) +# Class: RTCRtcpFeedback ## Constructors -### constructor +### new RTCRtcpFeedback() -• **new RTCRtcpFeedback**(`props?`): [`RTCRtcpFeedback`](RTCRtcpFeedback.md) +> **new RTCRtcpFeedback**(`props`): [`RTCRtcpFeedback`](RTCRtcpFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCRtcpFeedback`](RTCRtcpFeedback.md)\> | +• **props**: `Partial`\<[`RTCRtcpFeedback`](RTCRtcpFeedback.md)\> = `{}` #### Returns @@ -31,12 +22,12 @@ ## Properties -### parameter +### parameter? -• `Optional` **parameter**: `string` +> `optional` **parameter**: `string` -___ +*** ### type -• **type**: `string` +> **type**: `string` diff --git a/doc/classes/RTCRtcpParameters.md b/doc/classes/RTCRtcpParameters.md index ada9837d2..67fb6241b 100644 --- a/doc/classes/RTCRtcpParameters.md +++ b/doc/classes/RTCRtcpParameters.md @@ -1,30 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtcpParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtcpParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtcpParameters.md#constructor) +[werift](../globals.md) / RTCRtcpParameters -### Properties - -- [cname](RTCRtcpParameters.md#cname) -- [mux](RTCRtcpParameters.md#mux) -- [ssrc](RTCRtcpParameters.md#ssrc) +# Class: RTCRtcpParameters ## Constructors -### constructor +### new RTCRtcpParameters() -• **new RTCRtcpParameters**(`props?`): [`RTCRtcpParameters`](RTCRtcpParameters.md) +> **new RTCRtcpParameters**(`props`): [`RTCRtcpParameters`](RTCRtcpParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCRtcpParameters`](RTCRtcpParameters.md)\> | +• **props**: `Partial`\<[`RTCRtcpParameters`](RTCRtcpParameters.md)\> = `{}` #### Returns @@ -32,18 +22,18 @@ ## Properties -### cname +### cname? -• `Optional` **cname**: `string` +> `optional` **cname**: `string` -___ +*** ### mux -• **mux**: `boolean` = `false` +> **mux**: `boolean` = `false` -___ +*** -### ssrc +### ssrc? -• `Optional` **ssrc**: `number` +> `optional` **ssrc**: `number` diff --git a/doc/classes/RTCRtpCodecParameters.md b/doc/classes/RTCRtpCodecParameters.md index fe8c808aa..1a3f69c9e 100644 --- a/doc/classes/RTCRtpCodecParameters.md +++ b/doc/classes/RTCRtpCodecParameters.md @@ -1,40 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpCodecParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtpCodecParameters - -## Table of contents - -### Constructors - -- [constructor](RTCRtpCodecParameters.md#constructor) +*** -### Properties +[werift](../globals.md) / RTCRtpCodecParameters -- [channels](RTCRtpCodecParameters.md#channels) -- [clockRate](RTCRtpCodecParameters.md#clockrate) -- [direction](RTCRtpCodecParameters.md#direction) -- [mimeType](RTCRtpCodecParameters.md#mimetype) -- [parameters](RTCRtpCodecParameters.md#parameters) -- [payloadType](RTCRtpCodecParameters.md#payloadtype) -- [rtcpFeedback](RTCRtpCodecParameters.md#rtcpfeedback) - -### Accessors - -- [contentType](RTCRtpCodecParameters.md#contenttype) -- [name](RTCRtpCodecParameters.md#name) -- [str](RTCRtpCodecParameters.md#str) +# Class: RTCRtpCodecParameters ## Constructors -### constructor +### new RTCRtpCodecParameters() -• **new RTCRtpCodecParameters**(`props`): [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) +> **new RTCRtpCodecParameters**(`props`): [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Pick`\<[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md), ``"mimeType"`` \| ``"clockRate"``\> & `Partial`\<[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)\> | +• **props**: `Pick`\<[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md), `"mimeType"` \| `"clockRate"`\> & `Partial`\<[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)\> #### Returns @@ -42,74 +22,74 @@ ## Properties -### channels +### channels? -• `Optional` **channels**: `number` +> `optional` **channels**: `number` -___ +*** ### clockRate -• **clockRate**: `number` +> **clockRate**: `number` -___ +*** ### direction -• **direction**: ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` \| ``"all"`` = `"all"` +> **direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` \| `"all"` = `"all"` -___ +*** ### mimeType -• **mimeType**: `string` +> **mimeType**: `string` -___ +*** -### parameters +### parameters? -• `Optional` **parameters**: `string` +> `optional` **parameters**: `string` -___ +*** ### payloadType -• **payloadType**: `number` +> **payloadType**: `number` When specifying a codec with a fixed payloadType such as PCMU, it is necessary to set the correct PayloadType in RTCRtpCodecParameters in advance. -___ +*** ### rtcpFeedback -• **rtcpFeedback**: [`RTCPFB`](../modules.md#rtcpfb)[] = `[]` +> **rtcpFeedback**: [`RTCPFB`](../type-aliases/RTCPFB.md)[] = `[]` ## Accessors ### contentType -• `get` **contentType**(): `string` +> `get` **contentType**(): `string` #### Returns `string` -___ +*** ### name -• `get` **name**(): `string` +> `get` **name**(): `string` #### Returns `string` -___ +*** ### str -• `get` **str**(): `string` +> `get` **str**(): `string` #### Returns diff --git a/doc/classes/RTCRtpCodingParameters.md b/doc/classes/RTCRtpCodingParameters.md index a8166a220..d2ebfeace 100644 --- a/doc/classes/RTCRtpCodingParameters.md +++ b/doc/classes/RTCRtpCodingParameters.md @@ -1,30 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpCodingParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtpCodingParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtpCodingParameters.md#constructor) +[werift](../globals.md) / RTCRtpCodingParameters -### Properties - -- [payloadType](RTCRtpCodingParameters.md#payloadtype) -- [rtx](RTCRtpCodingParameters.md#rtx) -- [ssrc](RTCRtpCodingParameters.md#ssrc) +# Class: RTCRtpCodingParameters ## Constructors -### constructor +### new RTCRtpCodingParameters() -• **new RTCRtpCodingParameters**(`props`): [`RTCRtpCodingParameters`](RTCRtpCodingParameters.md) +> **new RTCRtpCodingParameters**(`props`): [`RTCRtpCodingParameters`](RTCRtpCodingParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCRtpCodingParameters`](RTCRtpCodingParameters.md)\> & `Pick`\<[`RTCRtpCodingParameters`](RTCRtpCodingParameters.md), ``"payloadType"`` \| ``"ssrc"``\> | +• **props**: `Partial`\<[`RTCRtpCodingParameters`](RTCRtpCodingParameters.md)\> & `Pick`\<[`RTCRtpCodingParameters`](RTCRtpCodingParameters.md), `"payloadType"` \| `"ssrc"`\> #### Returns @@ -34,16 +24,16 @@ ### payloadType -• **payloadType**: `number` +> **payloadType**: `number` -___ +*** -### rtx +### rtx? -• `Optional` **rtx**: [`RTCRtpRtxParameters`](RTCRtpRtxParameters.md) +> `optional` **rtx**: [`RTCRtpRtxParameters`](RTCRtpRtxParameters.md) -___ +*** ### ssrc -• **ssrc**: `number` +> **ssrc**: `number` diff --git a/doc/classes/RTCRtpHeaderExtensionParameters.md b/doc/classes/RTCRtpHeaderExtensionParameters.md index 6c7424aa3..996800429 100644 --- a/doc/classes/RTCRtpHeaderExtensionParameters.md +++ b/doc/classes/RTCRtpHeaderExtensionParameters.md @@ -1,29 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpHeaderExtensionParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtpHeaderExtensionParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtpHeaderExtensionParameters.md#constructor) +[werift](../globals.md) / RTCRtpHeaderExtensionParameters -### Properties - -- [id](RTCRtpHeaderExtensionParameters.md#id) -- [uri](RTCRtpHeaderExtensionParameters.md#uri) +# Class: RTCRtpHeaderExtensionParameters ## Constructors -### constructor +### new RTCRtpHeaderExtensionParameters() -• **new RTCRtpHeaderExtensionParameters**(`props`): [`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md) +> **new RTCRtpHeaderExtensionParameters**(`props`): [`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md)\> & `Pick`\<[`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md), ``"uri"``\> | +• **props**: `Partial`\<[`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md)\> & `Pick`\<[`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md), `"uri"`\> #### Returns @@ -33,10 +24,10 @@ ### id -• **id**: `number` +> **id**: `number` -___ +*** ### uri -• **uri**: `string` +> **uri**: `string` diff --git a/doc/classes/RTCRtpReceiver.md b/doc/classes/RTCRtpReceiver.md index a60ee3c9a..c726cdb37 100644 --- a/doc/classes/RTCRtpReceiver.md +++ b/doc/classes/RTCRtpReceiver.md @@ -1,71 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpReceiver +[**werift**](../README.md) • **Docs** -# Class: RTCRtpReceiver +*** + +[werift](../globals.md) / RTCRtpReceiver -## Table of contents - -### Constructors - -- [constructor](RTCRtpReceiver.md#constructor) - -### Properties - -- [config](RTCRtpReceiver.md#config) -- [dtlsTransport](RTCRtpReceiver.md#dtlstransport) -- [kind](RTCRtpReceiver.md#kind) -- [lastSRtimestamp](RTCRtpReceiver.md#lastsrtimestamp) -- [latestRepairedRid](RTCRtpReceiver.md#latestrepairedrid) -- [latestRid](RTCRtpReceiver.md#latestrid) -- [onPacketLost](RTCRtpReceiver.md#onpacketlost) -- [onRtcp](RTCRtpReceiver.md#onrtcp) -- [receiveLastSRTimestamp](RTCRtpReceiver.md#receivelastsrtimestamp) -- [receiverTWCC](RTCRtpReceiver.md#receivertwcc) -- [remoteStreamId](RTCRtpReceiver.md#remotestreamid) -- [remoteTrackId](RTCRtpReceiver.md#remotetrackid) -- [rtcpRunning](RTCRtpReceiver.md#rtcprunning) -- [rtcpSsrc](RTCRtpReceiver.md#rtcpssrc) -- [sdesMid](RTCRtpReceiver.md#sdesmid) -- [stopped](RTCRtpReceiver.md#stopped) -- [trackByRID](RTCRtpReceiver.md#trackbyrid) -- [trackBySSRC](RTCRtpReceiver.md#trackbyssrc) -- [tracks](RTCRtpReceiver.md#tracks) -- [type](RTCRtpReceiver.md#type) -- [uuid](RTCRtpReceiver.md#uuid) - -### Accessors - -- [nackEnabled](RTCRtpReceiver.md#nackenabled) -- [pliEnabled](RTCRtpReceiver.md#plienabled) -- [track](RTCRtpReceiver.md#track) -- [twccEnabled](RTCRtpReceiver.md#twccenabled) - -### Methods - -- [addTrack](RTCRtpReceiver.md#addtrack) -- [getStats](RTCRtpReceiver.md#getstats) -- [handleRtcpPacket](RTCRtpReceiver.md#handlertcppacket) -- [handleRtpByRid](RTCRtpReceiver.md#handlertpbyrid) -- [handleRtpBySsrc](RTCRtpReceiver.md#handlertpbyssrc) -- [prepareReceive](RTCRtpReceiver.md#preparereceive) -- [runRtcp](RTCRtpReceiver.md#runrtcp) -- [sendRtcpPLI](RTCRtpReceiver.md#sendrtcppli) -- [setDtlsTransport](RTCRtpReceiver.md#setdtlstransport) -- [setupTWCC](RTCRtpReceiver.md#setuptwcc) -- [stop](RTCRtpReceiver.md#stop) +# Class: RTCRtpReceiver ## Constructors -### constructor +### new RTCRtpReceiver() -• **new RTCRtpReceiver**(`config`, `kind`, `rtcpSsrc`): [`RTCRtpReceiver`](RTCRtpReceiver.md) +> **new RTCRtpReceiver**(`config`, `kind`, `rtcpSsrc`): [`RTCRtpReceiver`](RTCRtpReceiver.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | [`PeerConfig`](../interfaces/PeerConfig.md) | -| `kind` | [`Kind`](../modules.md#kind) | -| `rtcpSsrc` | `number` | +• **config**: [`PeerConfig`](../interfaces/PeerConfig.md) + +• **kind**: [`Kind`](../type-aliases/Kind.md) + +• **rtcpSsrc**: `number` #### Returns @@ -75,210 +28,208 @@ ### config -• `Readonly` **config**: [`PeerConfig`](../interfaces/PeerConfig.md) +> `readonly` **config**: [`PeerConfig`](../interfaces/PeerConfig.md) -___ +*** ### dtlsTransport -• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) +> **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) -___ +*** ### kind -• **kind**: [`Kind`](../modules.md#kind) +> **kind**: [`Kind`](../type-aliases/Kind.md) -___ +*** ### lastSRtimestamp -• `Readonly` **lastSRtimestamp**: `Object` = `{}` +> `readonly` **lastSRtimestamp**: `object` = `{}` last sender Report Timestamp compactNtp -#### Index signature +#### Index Signature -▪ [ssrc: `number`]: `number` + \[`ssrc`: `number`\]: `number` -___ +*** -### latestRepairedRid +### latestRepairedRid? -• `Optional` **latestRepairedRid**: `string` +> `optional` **latestRepairedRid**: `string` -___ +*** -### latestRid +### latestRid? -• `Optional` **latestRid**: `string` +> `optional` **latestRid**: `string` -___ +*** ### onPacketLost -• `Readonly` **onPacketLost**: `Event`\<[[`GenericNack`](GenericNack.md)]\> +> `readonly` **onPacketLost**: [`Event`](Event.md)\<[[`GenericNack`](GenericNack.md)]\> -___ +*** ### onRtcp -• `Readonly` **onRtcp**: `Event`\<[[`RtcpPacket`](../modules.md#rtcppacket)]\> +> `readonly` **onRtcp**: [`Event`](Event.md)\<[[`RtcpPacket`](../type-aliases/RtcpPacket.md)]\> -___ +*** ### receiveLastSRTimestamp -• `Readonly` **receiveLastSRTimestamp**: `Object` = `{}` +> `readonly` **receiveLastSRTimestamp**: `object` = `{}` seconds -#### Index signature +#### Index Signature -▪ [ssrc: `number`]: `number` + \[`ssrc`: `number`\]: `number` -___ +*** -### receiverTWCC +### receiverTWCC? -• `Optional` **receiverTWCC**: `ReceiverTWCC` +> `optional` **receiverTWCC**: `ReceiverTWCC` -___ +*** -### remoteStreamId +### remoteStreamId? -• `Optional` **remoteStreamId**: `string` +> `optional` **remoteStreamId**: `string` -___ +*** -### remoteTrackId +### remoteTrackId? -• `Optional` **remoteTrackId**: `string` +> `optional` **remoteTrackId**: `string` -___ +*** ### rtcpRunning -• **rtcpRunning**: `boolean` = `false` +> **rtcpRunning**: `boolean` = `false` -___ +*** ### rtcpSsrc -• **rtcpSsrc**: `number` +> **rtcpSsrc**: `number` -___ +*** -### sdesMid +### sdesMid? -• `Optional` **sdesMid**: `string` +> `optional` **sdesMid**: `string` -___ +*** ### stopped -• **stopped**: `boolean` = `false` +> **stopped**: `boolean` = `false` -___ +*** ### trackByRID -• `Readonly` **trackByRID**: `Object` = `{}` +> `readonly` **trackByRID**: `object` = `{}` -#### Index signature +#### Index Signature -▪ [rid: `string`]: [`MediaStreamTrack`](MediaStreamTrack.md) + \[`rid`: `string`\]: [`MediaStreamTrack`](MediaStreamTrack.md) -___ +*** ### trackBySSRC -• `Readonly` **trackBySSRC**: `Object` = `{}` +> `readonly` **trackBySSRC**: `object` = `{}` -#### Index signature +#### Index Signature -▪ [ssrc: `string`]: [`MediaStreamTrack`](MediaStreamTrack.md) + \[`ssrc`: `string`\]: [`MediaStreamTrack`](MediaStreamTrack.md) -___ +*** ### tracks -• `Readonly` **tracks**: [`MediaStreamTrack`](MediaStreamTrack.md)[] = `[]` +> `readonly` **tracks**: [`MediaStreamTrack`](MediaStreamTrack.md)[] = `[]` -___ +*** ### type -• `Readonly` **type**: ``"receiver"`` +> `readonly` **type**: `"receiver"` = `"receiver"` -___ +*** ### uuid -• `Readonly` **uuid**: `string` +> `readonly` **uuid**: `string` ## Accessors ### nackEnabled -• `get` **nackEnabled**(): `undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +> `get` **nackEnabled**(): `undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) #### Returns -`undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +`undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) -___ +*** ### pliEnabled -• `get` **pliEnabled**(): `undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +> `get` **pliEnabled**(): `undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) #### Returns -`undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +`undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) -___ +*** ### track -• `get` **track**(): [`MediaStreamTrack`](MediaStreamTrack.md) +> `get` **track**(): [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns [`MediaStreamTrack`](MediaStreamTrack.md) -___ +*** ### twccEnabled -• `get` **twccEnabled**(): `undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +> `get` **twccEnabled**(): `undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) #### Returns -`undefined` \| [`RTCPFB`](../modules.md#rtcpfb) +`undefined` \| [`RTCPFB`](../type-aliases/RTCPFB.md) ## Methods -### addTrack +### addTrack() -▸ **addTrack**(`track`): `boolean` +> **addTrack**(`track`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `track` | [`MediaStreamTrack`](MediaStreamTrack.md) | +• **track**: [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns `boolean` -___ +*** -### getStats +### getStats() -▸ **getStats**(): `void` +> **getStats**(): `void` todo impl @@ -286,138 +237,127 @@ todo impl `void` -___ +*** -### handleRtcpPacket +### handleRtcpPacket() -▸ **handleRtcpPacket**(`packet`): `void` +> **handleRtcpPacket**(`packet`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `packet` | [`RtcpPacket`](../modules.md#rtcppacket) | +• **packet**: [`RtcpPacket`](../type-aliases/RtcpPacket.md) #### Returns `void` -___ +*** -### handleRtpByRid +### handleRtpByRid() -▸ **handleRtpByRid**(`packet`, `rid`, `extensions`): `void` +> **handleRtpByRid**(`packet`, `rid`, `extensions`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `packet` | [`RtpPacket`](RtpPacket.md) | -| `rid` | `string` | -| `extensions` | `Extensions` | +• **packet**: [`RtpPacket`](RtpPacket.md) + +• **rid**: `string` + +• **extensions**: `Extensions` #### Returns `void` -___ +*** -### handleRtpBySsrc +### handleRtpBySsrc() -▸ **handleRtpBySsrc**(`packet`, `extensions`): `void` +> **handleRtpBySsrc**(`packet`, `extensions`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `packet` | [`RtpPacket`](RtpPacket.md) | -| `extensions` | `Extensions` | +• **packet**: [`RtpPacket`](RtpPacket.md) + +• **extensions**: `Extensions` #### Returns `void` -___ +*** -### prepareReceive +### prepareReceive() -▸ **prepareReceive**(`params`): `void` +> **prepareReceive**(`params`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `params` | [`RTCRtpReceiveParameters`](../interfaces/RTCRtpReceiveParameters.md) | +• **params**: [`RTCRtpReceiveParameters`](../interfaces/RTCRtpReceiveParameters.md) #### Returns `void` -___ +*** -### runRtcp +### runRtcp() -▸ **runRtcp**(): `Promise`\<`void`\> +> **runRtcp**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### sendRtcpPLI +### sendRtcpPLI() -▸ **sendRtcpPLI**(`mediaSsrc`): `Promise`\<`void`\> +> **sendRtcpPLI**(`mediaSsrc`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `mediaSsrc` | `number` | +• **mediaSsrc**: `number` #### Returns `Promise`\<`void`\> -___ +*** -### setDtlsTransport +### setDtlsTransport() -▸ **setDtlsTransport**(`dtls`): `void` +> **setDtlsTransport**(`dtls`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `dtls` | [`RTCDtlsTransport`](RTCDtlsTransport.md) | +• **dtls**: [`RTCDtlsTransport`](RTCDtlsTransport.md) #### Returns `void` -___ +*** -### setupTWCC +### setupTWCC() -▸ **setupTWCC**(`mediaSourceSsrc`): `void` +> **setupTWCC**(`mediaSourceSsrc`): `void` setup TWCC if supported #### Parameters -| Name | Type | -| :------ | :------ | -| `mediaSourceSsrc` | `number` | +• **mediaSourceSsrc**: `number` #### Returns `void` -___ +*** -### stop +### stop() -▸ **stop**(): `void` +> **stop**(): `void` #### Returns diff --git a/doc/classes/RTCRtpRtxParameters.md b/doc/classes/RTCRtpRtxParameters.md index fe4d01692..329c1faf1 100644 --- a/doc/classes/RTCRtpRtxParameters.md +++ b/doc/classes/RTCRtpRtxParameters.md @@ -1,28 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpRtxParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtpRtxParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtpRtxParameters.md#constructor) +[werift](../globals.md) / RTCRtpRtxParameters -### Properties - -- [ssrc](RTCRtpRtxParameters.md#ssrc) +# Class: RTCRtpRtxParameters ## Constructors -### constructor +### new RTCRtpRtxParameters() -• **new RTCRtpRtxParameters**(`props?`): [`RTCRtpRtxParameters`](RTCRtpRtxParameters.md) +> **new RTCRtpRtxParameters**(`props`): [`RTCRtpRtxParameters`](RTCRtpRtxParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RTCRtpRtxParameters`](RTCRtpRtxParameters.md)\> | +• **props**: `Partial`\<[`RTCRtpRtxParameters`](RTCRtpRtxParameters.md)\> = `{}` #### Returns @@ -32,4 +24,4 @@ ### ssrc -• **ssrc**: `number` +> **ssrc**: `number` diff --git a/doc/classes/RTCRtpSender.md b/doc/classes/RTCRtpSender.md index 73e5c318c..30b0c022e 100644 --- a/doc/classes/RTCRtpSender.md +++ b/doc/classes/RTCRtpSender.md @@ -1,63 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpSender +[**werift**](../README.md) • **Docs** -# Class: RTCRtpSender +*** + +[werift](../globals.md) / RTCRtpSender -## Table of contents - -### Constructors - -- [constructor](RTCRtpSender.md#constructor) - -### Properties - -- [codec](RTCRtpSender.md#codec) -- [dtlsTransport](RTCRtpSender.md#dtlstransport) -- [kind](RTCRtpSender.md#kind) -- [onGenericNack](RTCRtpSender.md#ongenericnack) -- [onPictureLossIndication](RTCRtpSender.md#onpicturelossindication) -- [onReady](RTCRtpSender.md#onready) -- [onRtcp](RTCRtpSender.md#onrtcp) -- [receiverEstimatedMaxBitrate](RTCRtpSender.md#receiverestimatedmaxbitrate) -- [redEncoder](RTCRtpSender.md#redencoder) -- [redRedundantPayloadType](RTCRtpSender.md#redredundantpayloadtype) -- [rtcpRunning](RTCRtpSender.md#rtcprunning) -- [rtxSsrc](RTCRtpSender.md#rtxssrc) -- [senderBWE](RTCRtpSender.md#senderbwe) -- [ssrc](RTCRtpSender.md#ssrc) -- [stopped](RTCRtpSender.md#stopped) -- [streamId](RTCRtpSender.md#streamid) -- [track](RTCRtpSender.md#track) -- [trackId](RTCRtpSender.md#trackid) -- [trackOrKind](RTCRtpSender.md#trackorkind) -- [type](RTCRtpSender.md#type) - -### Accessors - -- [redDistance](RTCRtpSender.md#reddistance) - -### Methods - -- [handleRtcpPacket](RTCRtpSender.md#handlertcppacket) -- [prepareSend](RTCRtpSender.md#preparesend) -- [registerTrack](RTCRtpSender.md#registertrack) -- [replaceRTP](RTCRtpSender.md#replacertp) -- [replaceTrack](RTCRtpSender.md#replacetrack) -- [runRtcp](RTCRtpSender.md#runrtcp) -- [sendRtp](RTCRtpSender.md#sendrtp) -- [setDtlsTransport](RTCRtpSender.md#setdtlstransport) -- [stop](RTCRtpSender.md#stop) +# Class: RTCRtpSender ## Constructors -### constructor +### new RTCRtpSender() -• **new RTCRtpSender**(`trackOrKind`): [`RTCRtpSender`](RTCRtpSender.md) +> **new RTCRtpSender**(`trackOrKind`): [`RTCRtpSender`](RTCRtpSender.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `trackOrKind` | ``"unknown"`` \| ``"audio"`` \| ``"video"`` \| ``"application"`` \| [`MediaStreamTrack`](MediaStreamTrack.md) | +• **trackOrKind**: [`Kind`](../type-aliases/Kind.md) \| [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns @@ -65,274 +22,255 @@ ## Properties -### codec +### codec? -• `Optional` **codec**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) +> `optional` **codec**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md) -___ +*** ### dtlsTransport -• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) +> **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) -___ +*** ### kind -• `Readonly` **kind**: [`Kind`](../modules.md#kind) +> `readonly` **kind**: [`Kind`](../type-aliases/Kind.md) -___ +*** ### onGenericNack -• `Readonly` **onGenericNack**: `Event`\<[[`GenericNack`](GenericNack.md)]\> +> `readonly` **onGenericNack**: [`Event`](Event.md)\<[[`GenericNack`](GenericNack.md)]\> -___ +*** ### onPictureLossIndication -• `Readonly` **onPictureLossIndication**: `Event`\<[]\> +> `readonly` **onPictureLossIndication**: [`Event`](Event.md)\<[]\> -___ +*** ### onReady -• `Readonly` **onReady**: `Event`\<`any`[]\> +> `readonly` **onReady**: [`Event`](Event.md)\<`any`[]\> -___ +*** ### onRtcp -• `Readonly` **onRtcp**: `Event`\<[[`RtcpPacket`](../modules.md#rtcppacket)]\> +> `readonly` **onRtcp**: [`Event`](Event.md)\<[[`RtcpPacket`](../type-aliases/RtcpPacket.md)]\> -___ +*** ### receiverEstimatedMaxBitrate -• **receiverEstimatedMaxBitrate**: `bigint` +> **receiverEstimatedMaxBitrate**: `bigint` -___ +*** ### redEncoder -• **redEncoder**: [`RedEncoder`](RedEncoder.md) +> **redEncoder**: [`RedEncoder`](RedEncoder.md) -___ +*** -### redRedundantPayloadType +### redRedundantPayloadType? -• `Optional` **redRedundantPayloadType**: `number` +> `optional` **redRedundantPayloadType**: `number` -___ +*** ### rtcpRunning -• **rtcpRunning**: `boolean` = `false` +> **rtcpRunning**: `boolean` = `false` -___ +*** ### rtxSsrc -• `Readonly` **rtxSsrc**: `number` +> `readonly` **rtxSsrc**: `number` -___ +*** ### senderBWE -• `Readonly` **senderBWE**: `SenderBandwidthEstimator` +> `readonly` **senderBWE**: `SenderBandwidthEstimator` -___ +*** ### ssrc -• `Readonly` **ssrc**: `number` +> `readonly` **ssrc**: `number` -___ +*** ### stopped -• **stopped**: `boolean` = `false` +> **stopped**: `boolean` = `false` -___ +*** ### streamId -• **streamId**: `string` +> **streamId**: `string` -___ +*** -### track +### track? -• `Optional` **track**: [`MediaStreamTrack`](MediaStreamTrack.md) +> `optional` **track**: [`MediaStreamTrack`](MediaStreamTrack.md) -___ +*** ### trackId -• `Readonly` **trackId**: `string` +> `readonly` **trackId**: `string` -___ +*** ### trackOrKind -• **trackOrKind**: ``"unknown"`` \| ``"audio"`` \| ``"video"`` \| ``"application"`` \| [`MediaStreamTrack`](MediaStreamTrack.md) +> **trackOrKind**: [`Kind`](../type-aliases/Kind.md) \| [`MediaStreamTrack`](MediaStreamTrack.md) -___ +*** ### type -• `Readonly` **type**: ``"sender"`` +> `readonly` **type**: `"sender"` = `"sender"` ## Accessors ### redDistance -• `get` **redDistance**(): `number` - -#### Returns - -`number` +> `get` **redDistance**(): `number` -• `set` **redDistance**(`n`): `void` +> `set` **redDistance**(`n`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `n` | `number` | +• **n**: `number` #### Returns -`void` +`number` ## Methods -### handleRtcpPacket +### handleRtcpPacket() -▸ **handleRtcpPacket**(`rtcpPacket`): `void` +> **handleRtcpPacket**(`rtcpPacket`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `rtcpPacket` | [`RtcpPacket`](../modules.md#rtcppacket) | +• **rtcpPacket**: [`RtcpPacket`](../type-aliases/RtcpPacket.md) #### Returns `void` -___ +*** -### prepareSend +### prepareSend() -▸ **prepareSend**(`params`): `void` +> **prepareSend**(`params`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `params` | [`RTCRtpParameters`](../interfaces/RTCRtpParameters.md) | +• **params**: [`RTCRtpParameters`](../interfaces/RTCRtpParameters.md) #### Returns `void` -___ +*** -### registerTrack +### registerTrack() -▸ **registerTrack**(`track`): `void` +> **registerTrack**(`track`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `track` | [`MediaStreamTrack`](MediaStreamTrack.md) | +• **track**: [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns `void` -___ +*** -### replaceRTP +### replaceRTP() -▸ **replaceRTP**(`«destructured»`, `discontinuity?`): `void` +> **replaceRTP**(`__namedParameters`, `discontinuity`): `void` #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `«destructured»` | `Pick`\<[`RtpHeader`](RtpHeader.md), ``"sequenceNumber"`` \| ``"timestamp"``\> | `undefined` | -| `discontinuity` | `boolean` | `false` | +• **\_\_namedParameters**: `Pick`\<[`RtpHeader`](RtpHeader.md), `"sequenceNumber"` \| `"timestamp"`\> + +• **discontinuity**: `boolean` = `false` #### Returns `void` -___ +*** -### replaceTrack +### replaceTrack() -▸ **replaceTrack**(`track`): `Promise`\<`void`\> +> **replaceTrack**(`track`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `track` | ``null`` \| [`MediaStreamTrack`](MediaStreamTrack.md) | +• **track**: `null` \| [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns `Promise`\<`void`\> -___ +*** -### runRtcp +### runRtcp() -▸ **runRtcp**(): `Promise`\<`void`\> +> **runRtcp**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### sendRtp +### sendRtp() -▸ **sendRtp**(`rtp`): `Promise`\<`void`\> +> **sendRtp**(`rtp`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `rtp` | `Buffer` \| [`RtpPacket`](RtpPacket.md) | +• **rtp**: `Buffer` \| [`RtpPacket`](RtpPacket.md) #### Returns `Promise`\<`void`\> -___ +*** -### setDtlsTransport +### setDtlsTransport() -▸ **setDtlsTransport**(`dtlsTransport`): `void` +> **setDtlsTransport**(`dtlsTransport`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `dtlsTransport` | [`RTCDtlsTransport`](RTCDtlsTransport.md) | +• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) #### Returns `void` -___ +*** -### stop +### stop() -▸ **stop**(): `void` +> **stop**(): `void` #### Returns diff --git a/doc/classes/RTCRtpSimulcastParameters.md b/doc/classes/RTCRtpSimulcastParameters.md index 67b271fbe..04f5cba48 100644 --- a/doc/classes/RTCRtpSimulcastParameters.md +++ b/doc/classes/RTCRtpSimulcastParameters.md @@ -1,29 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpSimulcastParameters +[**werift**](../README.md) • **Docs** -# Class: RTCRtpSimulcastParameters - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtpSimulcastParameters.md#constructor) +[werift](../globals.md) / RTCRtpSimulcastParameters -### Properties - -- [direction](RTCRtpSimulcastParameters.md#direction) -- [rid](RTCRtpSimulcastParameters.md#rid) +# Class: RTCRtpSimulcastParameters ## Constructors -### constructor +### new RTCRtpSimulcastParameters() -• **new RTCRtpSimulcastParameters**(`props`): [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md) +> **new RTCRtpSimulcastParameters**(`props`): [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md) | +• **props**: [`RTCRtpSimulcastParameters`](RTCRtpSimulcastParameters.md) #### Returns @@ -33,10 +24,10 @@ ### direction -• **direction**: ``"send"`` \| ``"recv"`` +> **direction**: `"send"` \| `"recv"` -___ +*** ### rid -• **rid**: `string` +> **rid**: `string` diff --git a/doc/classes/RTCRtpTransceiver.md b/doc/classes/RTCRtpTransceiver.md index c78f83a0d..9c3895ef1 100644 --- a/doc/classes/RTCRtpTransceiver.md +++ b/doc/classes/RTCRtpTransceiver.md @@ -1,62 +1,30 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpTransceiver +[**werift**](../README.md) • **Docs** -# Class: RTCRtpTransceiver - -## Table of contents - -### Constructors +*** -- [constructor](RTCRtpTransceiver.md#constructor) +[werift](../globals.md) / RTCRtpTransceiver -### Properties +# Class: RTCRtpTransceiver -- [\_codecs](RTCRtpTransceiver.md#_codecs) -- [headerExtensions](RTCRtpTransceiver.md#headerextensions) -- [id](RTCRtpTransceiver.md#id) -- [kind](RTCRtpTransceiver.md#kind) -- [mLineIndex](RTCRtpTransceiver.md#mlineindex) -- [mid](RTCRtpTransceiver.md#mid) -- [offerDirection](RTCRtpTransceiver.md#offerdirection) -- [onTrack](RTCRtpTransceiver.md#ontrack) -- [options](RTCRtpTransceiver.md#options) -- [receiver](RTCRtpTransceiver.md#receiver) -- [sender](RTCRtpTransceiver.md#sender) -- [stopped](RTCRtpTransceiver.md#stopped) -- [stopping](RTCRtpTransceiver.md#stopping) -- [usedForSender](RTCRtpTransceiver.md#usedforsender) +## Constructors -### Accessors +### new RTCRtpTransceiver() -- [codecs](RTCRtpTransceiver.md#codecs) -- [currentDirection](RTCRtpTransceiver.md#currentdirection) -- [direction](RTCRtpTransceiver.md#direction) -- [dtlsTransport](RTCRtpTransceiver.md#dtlstransport) -- [msid](RTCRtpTransceiver.md#msid) +> **new RTCRtpTransceiver**(`kind`, `dtlsTransport`, `receiver`, `sender`, `_direction`): [`RTCRtpTransceiver`](RTCRtpTransceiver.md) -### Methods +#### Parameters -- [addTrack](RTCRtpTransceiver.md#addtrack) -- [getPayloadType](RTCRtpTransceiver.md#getpayloadtype) -- [setCurrentDirection](RTCRtpTransceiver.md#setcurrentdirection) -- [setDirection](RTCRtpTransceiver.md#setdirection) -- [setDtlsTransport](RTCRtpTransceiver.md#setdtlstransport) -- [stop](RTCRtpTransceiver.md#stop) +• **kind**: [`Kind`](../type-aliases/Kind.md) -## Constructors +• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) -### constructor +• **receiver**: [`RTCRtpReceiver`](RTCRtpReceiver.md) -• **new RTCRtpTransceiver**(`kind`, `dtlsTransport`, `receiver`, `sender`, `_direction`): [`RTCRtpTransceiver`](RTCRtpTransceiver.md) +• **sender**: [`RTCRtpSender`](RTCRtpSender.md) -#### Parameters +• **\_direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -| Name | Type | Description | -| :------ | :------ | :------ | -| `kind` | [`Kind`](../modules.md#kind) | - | -| `dtlsTransport` | [`RTCDtlsTransport`](RTCDtlsTransport.md) | - | -| `receiver` | [`RTCRtpReceiver`](RTCRtpReceiver.md) | - | -| `sender` | [`RTCRtpSender`](RTCRtpSender.md) | - | -| `_direction` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | RFC 8829 4.2.4. direction the transceiver was initialized with | +RFC 8829 4.2.4. direction the transceiver was initialized with #### Returns @@ -66,85 +34,85 @@ ### \_codecs -• **\_codecs**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] = `[]` +> **\_codecs**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] = `[]` -___ +*** ### headerExtensions -• **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md)[] = `[]` +> **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](RTCRtpHeaderExtensionParameters.md)[] = `[]` -___ +*** ### id -• `Readonly` **id**: `string` +> `readonly` **id**: `string` -___ +*** ### kind -• `Readonly` **kind**: [`Kind`](../modules.md#kind) +> `readonly` **kind**: [`Kind`](../type-aliases/Kind.md) -___ +*** -### mLineIndex +### mLineIndex? -• `Optional` **mLineIndex**: `number` +> `optional` **mLineIndex**: `number` -___ +*** -### mid +### mid? -• `Optional` **mid**: `string` +> `optional` **mid**: `string` -___ +*** ### offerDirection -• **offerDirection**: ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +> **offerDirection**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -___ +*** ### onTrack -• `Readonly` **onTrack**: `Event`\<[[`MediaStreamTrack`](MediaStreamTrack.md), [`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> +> `readonly` **onTrack**: [`Event`](Event.md)\<[[`MediaStreamTrack`](MediaStreamTrack.md), [`RTCRtpTransceiver`](RTCRtpTransceiver.md)]\> -___ +*** ### options -• **options**: `Partial`\<[`TransceiverOptions`](../interfaces/TransceiverOptions.md)\> = `{}` +> **options**: `Partial`\<[`TransceiverOptions`](../interfaces/TransceiverOptions.md)\> = `{}` -___ +*** ### receiver -• **receiver**: [`RTCRtpReceiver`](RTCRtpReceiver.md) +> **receiver**: [`RTCRtpReceiver`](RTCRtpReceiver.md) -___ +*** ### sender -• **sender**: [`RTCRtpSender`](RTCRtpSender.md) +> **sender**: [`RTCRtpSender`](RTCRtpSender.md) -___ +*** ### stopped -• **stopped**: `boolean` = `false` +> **stopped**: `boolean` = `false` -___ +*** ### stopping -• **stopping**: `boolean` = `false` +> **stopping**: `boolean` = `false` -___ +*** ### usedForSender -• **usedForSender**: `boolean` = `false` +> **usedForSender**: `boolean` = `false` should not be reused because it has been used for sending before. @@ -152,63 +120,57 @@ should not be reused because it has been used for sending before. ### codecs -• `get` **codecs**(): [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] +> `get` **codecs**(): [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] -#### Returns - -[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] - -• `set` **codecs**(`codecs`): `void` +> `set` **codecs**(`codecs`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `codecs` | [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] | +• **codecs**: [`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] #### Returns -`void` +[`RTCRtpCodecParameters`](RTCRtpCodecParameters.md)[] -___ +*** ### currentDirection -• `get` **currentDirection**(): `undefined` \| ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +> `get` **currentDirection**(): `undefined` \| `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` RFC 8829 4.2.5. last negotiated direction #### Returns -`undefined` \| ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +`undefined` \| `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -___ +*** ### direction -• `get` **direction**(): ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +> `get` **direction**(): `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` RFC 8829 4.2.4. setDirectionに渡された最後の値を示します #### Returns -``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +`"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -___ +*** ### dtlsTransport -• `get` **dtlsTransport**(): [`RTCDtlsTransport`](RTCDtlsTransport.md) +> `get` **dtlsTransport**(): [`RTCDtlsTransport`](RTCDtlsTransport.md) #### Returns [`RTCDtlsTransport`](RTCDtlsTransport.md) -___ +*** ### msid -• `get` **msid**(): `string` +> `get` **msid**(): `string` #### Returns @@ -216,89 +178,79 @@ ___ ## Methods -### addTrack +### addTrack() -▸ **addTrack**(`track`): `void` +> **addTrack**(`track`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `track` | [`MediaStreamTrack`](MediaStreamTrack.md) | +• **track**: [`MediaStreamTrack`](MediaStreamTrack.md) #### Returns `void` -___ +*** -### getPayloadType +### getPayloadType() -▸ **getPayloadType**(`mimeType`): `undefined` \| `number` +> **getPayloadType**(`mimeType`): `undefined` \| `number` #### Parameters -| Name | Type | -| :------ | :------ | -| `mimeType` | `string` | +• **mimeType**: `string` #### Returns `undefined` \| `number` -___ +*** -### setCurrentDirection +### setCurrentDirection() -▸ **setCurrentDirection**(`direction`): `void` +> **setCurrentDirection**(`direction`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `direction` | `undefined` \| ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | +• **direction**: `undefined` \| `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` #### Returns `void` -___ +*** -### setDirection +### setDirection() -▸ **setDirection**(`direction`): `void` +> **setDirection**(`direction`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `direction` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | +• **direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` #### Returns `void` -___ +*** -### setDtlsTransport +### setDtlsTransport() -▸ **setDtlsTransport**(`dtls`): `void` +> **setDtlsTransport**(`dtls`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `dtls` | [`RTCDtlsTransport`](RTCDtlsTransport.md) | +• **dtls**: [`RTCDtlsTransport`](RTCDtlsTransport.md) #### Returns `void` -___ +*** -### stop +### stop() -▸ **stop**(): `void` +> **stop**(): `void` #### Returns diff --git a/doc/classes/RTCSctpCapabilities.md b/doc/classes/RTCSctpCapabilities.md index 1fb6b3929..27f1de38f 100644 --- a/doc/classes/RTCSctpCapabilities.md +++ b/doc/classes/RTCSctpCapabilities.md @@ -1,28 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCSctpCapabilities +[**werift**](../README.md) • **Docs** -# Class: RTCSctpCapabilities - -## Table of contents - -### Constructors - -- [constructor](RTCSctpCapabilities.md#constructor) +*** -### Properties +[werift](../globals.md) / RTCSctpCapabilities -- [maxMessageSize](RTCSctpCapabilities.md#maxmessagesize) +# Class: RTCSctpCapabilities ## Constructors -### constructor +### new RTCSctpCapabilities() -• **new RTCSctpCapabilities**(`maxMessageSize`): [`RTCSctpCapabilities`](RTCSctpCapabilities.md) +> **new RTCSctpCapabilities**(`maxMessageSize`): [`RTCSctpCapabilities`](RTCSctpCapabilities.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `maxMessageSize` | `number` | +• **maxMessageSize**: `number` #### Returns @@ -32,4 +24,4 @@ ### maxMessageSize -• **maxMessageSize**: `number` +> **maxMessageSize**: `number` diff --git a/doc/classes/RTCSctpTransport.md b/doc/classes/RTCSctpTransport.md index 29bcef240..c0a14f007 100644 --- a/doc/classes/RTCSctpTransport.md +++ b/doc/classes/RTCSctpTransport.md @@ -1,49 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCSctpTransport +[**werift**](../README.md) • **Docs** -# Class: RTCSctpTransport - -## Table of contents - -### Constructors - -- [constructor](RTCSctpTransport.md#constructor) - -### Properties - -- [bundled](RTCSctpTransport.md#bundled) -- [dataChannels](RTCSctpTransport.md#datachannels) -- [dtlsTransport](RTCSctpTransport.md#dtlstransport) -- [id](RTCSctpTransport.md#id) -- [mLineIndex](RTCSctpTransport.md#mlineindex) -- [mid](RTCSctpTransport.md#mid) -- [onDataChannel](RTCSctpTransport.md#ondatachannel) -- [port](RTCSctpTransport.md#port) -- [sctp](RTCSctpTransport.md#sctp) +*** -### Methods +[werift](../globals.md) / RTCSctpTransport -- [channelByLabel](RTCSctpTransport.md#channelbylabel) -- [dataChannelAddNegotiated](RTCSctpTransport.md#datachanneladdnegotiated) -- [dataChannelClose](RTCSctpTransport.md#datachannelclose) -- [dataChannelOpen](RTCSctpTransport.md#datachannelopen) -- [datachannelSend](RTCSctpTransport.md#datachannelsend) -- [setDtlsTransport](RTCSctpTransport.md#setdtlstransport) -- [setRemotePort](RTCSctpTransport.md#setremoteport) -- [start](RTCSctpTransport.md#start) -- [stop](RTCSctpTransport.md#stop) -- [getCapabilities](RTCSctpTransport.md#getcapabilities) +# Class: RTCSctpTransport ## Constructors -### constructor +### new RTCSctpTransport() -• **new RTCSctpTransport**(`port?`): [`RTCSctpTransport`](RTCSctpTransport.md) +> **new RTCSctpTransport**(`port`): [`RTCSctpTransport`](RTCSctpTransport.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `port` | `number` | `5000` | +• **port**: `number` = `5000` #### Returns @@ -53,204 +24,189 @@ ### bundled -• **bundled**: `boolean` = `false` +> **bundled**: `boolean` = `false` -___ +*** ### dataChannels -• **dataChannels**: `Object` = `{}` +> **dataChannels**: `object` = `{}` -#### Index signature +#### Index Signature -▪ [key: `number`]: [`RTCDataChannel`](RTCDataChannel.md) + \[`key`: `number`\]: [`RTCDataChannel`](RTCDataChannel.md) -___ +*** ### dtlsTransport -• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) +> **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) -___ +*** ### id -• `Readonly` **id**: `string` +> `readonly` **id**: `string` -___ +*** -### mLineIndex +### mLineIndex? -• `Optional` **mLineIndex**: `number` +> `optional` **mLineIndex**: `number` -___ +*** -### mid +### mid? -• `Optional` **mid**: `string` +> `optional` **mid**: `string` -___ +*** ### onDataChannel -• `Readonly` **onDataChannel**: `Event`\<[[`RTCDataChannel`](RTCDataChannel.md)]\> +> `readonly` **onDataChannel**: [`Event`](Event.md)\<[[`RTCDataChannel`](RTCDataChannel.md)]\> -___ +*** ### port -• **port**: `number` = `5000` +> **port**: `number` = `5000` -___ +*** ### sctp -• **sctp**: `SCTP` +> **sctp**: `SCTP` ## Methods -### channelByLabel +### channelByLabel() -▸ **channelByLabel**(`label`): `undefined` \| [`RTCDataChannel`](RTCDataChannel.md) +> **channelByLabel**(`label`): `undefined` \| [`RTCDataChannel`](RTCDataChannel.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `label` | `string` | +• **label**: `string` #### Returns `undefined` \| [`RTCDataChannel`](RTCDataChannel.md) -___ +*** -### dataChannelAddNegotiated +### dataChannelAddNegotiated() -▸ **dataChannelAddNegotiated**(`channel`): `void` +> **dataChannelAddNegotiated**(`channel`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `channel` | [`RTCDataChannel`](RTCDataChannel.md) | +• **channel**: [`RTCDataChannel`](RTCDataChannel.md) #### Returns `void` -___ +*** -### dataChannelClose +### dataChannelClose() -▸ **dataChannelClose**(`channel`): `void` +> **dataChannelClose**(`channel`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `channel` | [`RTCDataChannel`](RTCDataChannel.md) | +• **channel**: [`RTCDataChannel`](RTCDataChannel.md) #### Returns `void` -___ +*** -### dataChannelOpen +### dataChannelOpen() -▸ **dataChannelOpen**(`channel`): `void` +> **dataChannelOpen**(`channel`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `channel` | [`RTCDataChannel`](RTCDataChannel.md) | +• **channel**: [`RTCDataChannel`](RTCDataChannel.md) #### Returns `void` -___ +*** -### datachannelSend +### datachannelSend() -▸ **datachannelSend**(`channel`, `data`): `void` +> **datachannelSend**(`channel`, `data`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `channel` | [`RTCDataChannel`](RTCDataChannel.md) | -| `data` | `string` \| `Buffer` | +• **channel**: [`RTCDataChannel`](RTCDataChannel.md) + +• **data**: `string` \| `Buffer` #### Returns `void` -___ +*** -### setDtlsTransport +### setDtlsTransport() -▸ **setDtlsTransport**(`dtlsTransport`): `void` +> **setDtlsTransport**(`dtlsTransport`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `dtlsTransport` | [`RTCDtlsTransport`](RTCDtlsTransport.md) | +• **dtlsTransport**: [`RTCDtlsTransport`](RTCDtlsTransport.md) #### Returns `void` -___ +*** -### setRemotePort +### setRemotePort() -▸ **setRemotePort**(`port`): `void` +> **setRemotePort**(`port`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `port` | `number` | +• **port**: `number` #### Returns `void` -___ +*** -### start +### start() -▸ **start**(`remotePort`): `Promise`\<`void`\> +> **start**(`remotePort`): `Promise`\<`void`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `remotePort` | `number` | +• **remotePort**: `number` #### Returns `Promise`\<`void`\> -___ +*** -### stop +### stop() -▸ **stop**(): `Promise`\<`void`\> +> **stop**(): `Promise`\<`void`\> #### Returns `Promise`\<`void`\> -___ +*** -### getCapabilities +### getCapabilities() -▸ **getCapabilities**(): [`RTCSctpCapabilities`](RTCSctpCapabilities.md) +> `static` **getCapabilities**(): [`RTCSctpCapabilities`](RTCSctpCapabilities.md) #### Returns diff --git a/doc/classes/RTCSessionDescription.md b/doc/classes/RTCSessionDescription.md index e5ab3960a..9617c79e9 100644 --- a/doc/classes/RTCSessionDescription.md +++ b/doc/classes/RTCSessionDescription.md @@ -1,34 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCSessionDescription +[**werift**](../README.md) • **Docs** -# Class: RTCSessionDescription - -## Table of contents - -### Constructors - -- [constructor](RTCSessionDescription.md#constructor) - -### Properties +*** -- [sdp](RTCSessionDescription.md#sdp) -- [type](RTCSessionDescription.md#type) +[werift](../globals.md) / RTCSessionDescription -### Methods - -- [isThis](RTCSessionDescription.md#isthis) +# Class: RTCSessionDescription ## Constructors -### constructor +### new RTCSessionDescription() -• **new RTCSessionDescription**(`sdp`, `type`): [`RTCSessionDescription`](RTCSessionDescription.md) +> **new RTCSessionDescription**(`sdp`, `type`): [`RTCSessionDescription`](RTCSessionDescription.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `sdp` | `string` | -| `type` | ``"offer"`` \| ``"answer"`` | +• **sdp**: `string` + +• **type**: `"offer"` \| `"answer"` #### Returns @@ -38,26 +26,24 @@ ### sdp -• **sdp**: `string` +> **sdp**: `string` -___ +*** ### type -• **type**: ``"offer"`` \| ``"answer"`` +> **type**: `"offer"` \| `"answer"` ## Methods -### isThis +### isThis() -▸ **isThis**(`o`): `undefined` \| ``true`` +> `static` **isThis**(`o`): `undefined` \| `true` #### Parameters -| Name | Type | -| :------ | :------ | -| `o` | `any` | +• **o**: `any` #### Returns -`undefined` \| ``true`` +`undefined` \| `true` diff --git a/doc/classes/ReceiverEstimatedMaxBitrate.md b/doc/classes/ReceiverEstimatedMaxBitrate.md index bfd2bf5be..4082dc627 100644 --- a/doc/classes/ReceiverEstimatedMaxBitrate.md +++ b/doc/classes/ReceiverEstimatedMaxBitrate.md @@ -1,43 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / ReceiverEstimatedMaxBitrate +[**werift**](../README.md) • **Docs** -# Class: ReceiverEstimatedMaxBitrate - -## Table of contents - -### Constructors - -- [constructor](ReceiverEstimatedMaxBitrate.md#constructor) +*** -### Properties +[werift](../globals.md) / ReceiverEstimatedMaxBitrate -- [bitrate](ReceiverEstimatedMaxBitrate.md#bitrate) -- [brExp](ReceiverEstimatedMaxBitrate.md#brexp) -- [brMantissa](ReceiverEstimatedMaxBitrate.md#brmantissa) -- [count](ReceiverEstimatedMaxBitrate.md#count) -- [length](ReceiverEstimatedMaxBitrate.md#length) -- [mediaSsrc](ReceiverEstimatedMaxBitrate.md#mediassrc) -- [senderSsrc](ReceiverEstimatedMaxBitrate.md#senderssrc) -- [ssrcFeedbacks](ReceiverEstimatedMaxBitrate.md#ssrcfeedbacks) -- [ssrcNum](ReceiverEstimatedMaxBitrate.md#ssrcnum) -- [uniqueID](ReceiverEstimatedMaxBitrate.md#uniqueid) -- [count](ReceiverEstimatedMaxBitrate.md#count-1) - -### Methods - -- [serialize](ReceiverEstimatedMaxBitrate.md#serialize) -- [deSerialize](ReceiverEstimatedMaxBitrate.md#deserialize) +# Class: ReceiverEstimatedMaxBitrate ## Constructors -### constructor +### new ReceiverEstimatedMaxBitrate() -• **new ReceiverEstimatedMaxBitrate**(`props?`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) +> **new ReceiverEstimatedMaxBitrate**(`props`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md)\> | +• **props**: `Partial`\<[`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md)\> = `{}` #### Returns @@ -47,89 +24,87 @@ ### bitrate -• **bitrate**: `bigint` +> **bitrate**: `bigint` -___ +*** ### brExp -• **brExp**: `number` +> **brExp**: `number` -___ +*** ### brMantissa -• **brMantissa**: `number` +> **brMantissa**: `number` -___ +*** ### count -• **count**: `number` = `ReceiverEstimatedMaxBitrate.count` +> **count**: `number` = `ReceiverEstimatedMaxBitrate.count` -___ +*** ### length -• **length**: `number` +> **length**: `number` -___ +*** ### mediaSsrc -• **mediaSsrc**: `number` +> **mediaSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### ssrcFeedbacks -• **ssrcFeedbacks**: `number`[] = `[]` +> **ssrcFeedbacks**: `number`[] = `[]` -___ +*** ### ssrcNum -• **ssrcNum**: `number` = `0` +> **ssrcNum**: `number` = `0` -___ +*** ### uniqueID -• `Readonly` **uniqueID**: `string` = `"REMB"` +> `readonly` **uniqueID**: `string` = `"REMB"` -___ +*** ### count -▪ `Static` **count**: `number` = `15` +> `static` **count**: `number` = `15` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) +> `static` **deSerialize**(`data`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/RecvDelta.md b/doc/classes/RecvDelta.md index 6a89a4b62..ccf40f85b 100644 --- a/doc/classes/RecvDelta.md +++ b/doc/classes/RecvDelta.md @@ -1,37 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RecvDelta +[**werift**](../README.md) • **Docs** -# Class: RecvDelta - -## Table of contents - -### Constructors - -- [constructor](RecvDelta.md#constructor) +*** -### Properties +[werift](../globals.md) / RecvDelta -- [delta](RecvDelta.md#delta) -- [parsed](RecvDelta.md#parsed) -- [type](RecvDelta.md#type) - -### Methods - -- [deSerialize](RecvDelta.md#deserialize) -- [parseDelta](RecvDelta.md#parsedelta) -- [serialize](RecvDelta.md#serialize) -- [deSerialize](RecvDelta.md#deserialize-1) +# Class: RecvDelta ## Constructors -### constructor +### new RecvDelta() -• **new RecvDelta**(`props?`): [`RecvDelta`](RecvDelta.md) +> **new RecvDelta**(`props`): [`RecvDelta`](RecvDelta.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RecvDelta`](RecvDelta.md)\> | +• **props**: `Partial`\<[`RecvDelta`](RecvDelta.md)\> = `{}` #### Returns @@ -41,71 +24,67 @@ ### delta -• **delta**: `number` +> **delta**: `number` micro sec -___ +*** ### parsed -• **parsed**: `boolean` = `false` +> **parsed**: `boolean` = `false` -___ +*** -### type +### type? -• `Optional` **type**: [`TypeTCCPacketReceivedSmallDelta`](../enums/PacketStatus.md#typetccpacketreceivedsmalldelta) \| [`TypeTCCPacketReceivedLargeDelta`](../enums/PacketStatus.md#typetccpacketreceivedlargedelta) +> `optional` **type**: [`TypeTCCPacketReceivedSmallDelta`](../enumerations/PacketStatus.md#typetccpacketreceivedsmalldelta) \| [`TypeTCCPacketReceivedLargeDelta`](../enumerations/PacketStatus.md#typetccpacketreceivedlargedelta) optional (If undefined, it will be set automatically.) ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): `void` +> **deSerialize**(`data`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns `void` -___ +*** -### parseDelta +### parseDelta() -▸ **parseDelta**(): `void` +> **parseDelta**(): `void` #### Returns `void` -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RecvDelta`](RecvDelta.md) +> `static` **deSerialize**(`data`): [`RecvDelta`](RecvDelta.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/Red.md b/doc/classes/Red.md index 9c31c9822..97dd38ab4 100644 --- a/doc/classes/Red.md +++ b/doc/classes/Red.md @@ -1,28 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / Red +[**werift**](../README.md) • **Docs** -# Class: Red - -## Table of contents - -### Constructors - -- [constructor](Red.md#constructor) +*** -### Properties +[werift](../globals.md) / Red -- [blocks](Red.md#blocks) -- [header](Red.md#header) - -### Methods - -- [serialize](Red.md#serialize) -- [deSerialize](Red.md#deserialize) +# Class: Red ## Constructors -### constructor +### new Red() -• **new Red**(): [`Red`](Red.md) +> **new Red**(): [`Red`](Red.md) #### Returns @@ -32,35 +20,33 @@ ### blocks -• **blocks**: \{ `block`: `Buffer` ; `blockPT`: `number` ; `timestampOffset?`: `number` }[] = `[]` +> **blocks**: `object`[] = `[]` -___ +*** ### header -• **header**: [`RedHeader`](RedHeader.md) +> **header**: [`RedHeader`](RedHeader.md) ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`bufferOrArrayBuffer`): [`Red`](Red.md) +> `static` **deSerialize**(`bufferOrArrayBuffer`): [`Red`](Red.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bufferOrArrayBuffer` | `Buffer` \| `ArrayBuffer` | +• **bufferOrArrayBuffer**: `Buffer` \| `ArrayBuffer` #### Returns diff --git a/doc/classes/RedEncoder.md b/doc/classes/RedEncoder.md index 007b2eb27..b213a414e 100644 --- a/doc/classes/RedEncoder.md +++ b/doc/classes/RedEncoder.md @@ -1,34 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RedEncoder +[**werift**](../README.md) • **Docs** -# Class: RedEncoder - -## Table of contents - -### Constructors - -- [constructor](RedEncoder.md#constructor) - -### Properties - -- [cacheSize](RedEncoder.md#cachesize) -- [distance](RedEncoder.md#distance) +*** -### Methods +[werift](../globals.md) / RedEncoder -- [build](RedEncoder.md#build) -- [push](RedEncoder.md#push) +# Class: RedEncoder ## Constructors -### constructor +### new RedEncoder() -• **new RedEncoder**(`distance?`): [`RedEncoder`](RedEncoder.md) +> **new RedEncoder**(`distance`): [`RedEncoder`](RedEncoder.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `distance` | `number` | `1` | +• **distance**: `number` = `1` #### Returns @@ -38,38 +24,39 @@ ### cacheSize -• **cacheSize**: `number` = `10` +> **cacheSize**: `number` = `10` -___ +*** ### distance -• **distance**: `number` = `1` +> **distance**: `number` = `1` ## Methods -### build +### build() -▸ **build**(): [`Red`](Red.md) +> **build**(): [`Red`](Red.md) #### Returns [`Red`](Red.md) -___ +*** -### push +### push() -▸ **push**(`payload`): `void` +> **push**(`payload`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Object` | -| `payload.block` | `Buffer` | -| `payload.blockPT` | `number` | -| `payload.timestamp` | `number` | +• **payload** + +• **payload.block**: `Buffer` + +• **payload.blockPT**: `number` + +• **payload.timestamp**: `number` #### Returns diff --git a/doc/classes/RedHandler.md b/doc/classes/RedHandler.md index df707f59e..94a50555c 100644 --- a/doc/classes/RedHandler.md +++ b/doc/classes/RedHandler.md @@ -1,22 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / RedHandler +[**werift**](../README.md) • **Docs** -# Class: RedHandler - -## Table of contents - -### Constructors +*** -- [constructor](RedHandler.md#constructor) +[werift](../globals.md) / RedHandler -### Methods - -- [push](RedHandler.md#push) +# Class: RedHandler ## Constructors -### constructor +### new RedHandler() -• **new RedHandler**(): [`RedHandler`](RedHandler.md) +> **new RedHandler**(): [`RedHandler`](RedHandler.md) #### Returns @@ -24,16 +18,15 @@ ## Methods -### push +### push() -▸ **push**(`red`, `base`): [`RtpPacket`](RtpPacket.md)[] +> **push**(`red`, `base`): [`RtpPacket`](RtpPacket.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `red` | [`Red`](Red.md) | -| `base` | [`RtpPacket`](RtpPacket.md) | +• **red**: [`Red`](Red.md) + +• **base**: [`RtpPacket`](RtpPacket.md) #### Returns diff --git a/doc/classes/RedHeader.md b/doc/classes/RedHeader.md index 232787ec5..236968aaa 100644 --- a/doc/classes/RedHeader.md +++ b/doc/classes/RedHeader.md @@ -1,27 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / RedHeader +[**werift**](../README.md) • **Docs** -# Class: RedHeader - -## Table of contents - -### Constructors - -- [constructor](RedHeader.md#constructor) +*** -### Properties +[werift](../globals.md) / RedHeader -- [fields](RedHeader.md#fields) - -### Methods - -- [serialize](RedHeader.md#serialize) -- [deSerialize](RedHeader.md#deserialize) +# Class: RedHeader ## Constructors -### constructor +### new RedHeader() -• **new RedHeader**(): [`RedHeader`](RedHeader.md) +> **new RedHeader**(): [`RedHeader`](RedHeader.md) #### Returns @@ -31,29 +20,27 @@ ### fields -• **fields**: `RedHeaderField`[] = `[]` +> **fields**: `RedHeaderField`[] = `[]` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): readonly [[`RedHeader`](RedHeader.md), `number`] +> `static` **deSerialize**(`buf`): readonly [[`RedHeader`](RedHeader.md), `number`] #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/doc/classes/RtcpHeader.md b/doc/classes/RtcpHeader.md index 528e61da5..f3e140718 100644 --- a/doc/classes/RtcpHeader.md +++ b/doc/classes/RtcpHeader.md @@ -1,37 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpHeader +[**werift**](../README.md) • **Docs** -# Class: RtcpHeader - -## Table of contents - -### Constructors - -- [constructor](RtcpHeader.md#constructor) +*** -### Properties +[werift](../globals.md) / RtcpHeader -- [count](RtcpHeader.md#count) -- [length](RtcpHeader.md#length) -- [padding](RtcpHeader.md#padding) -- [type](RtcpHeader.md#type) -- [version](RtcpHeader.md#version) - -### Methods - -- [serialize](RtcpHeader.md#serialize) -- [deSerialize](RtcpHeader.md#deserialize) +# Class: RtcpHeader ## Constructors -### constructor +### new RtcpHeader() -• **new RtcpHeader**(`props?`): [`RtcpHeader`](RtcpHeader.md) +> **new RtcpHeader**(`props`): [`RtcpHeader`](RtcpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpHeader`](RtcpHeader.md)\> | +• **props**: `Partial`\<[`RtcpHeader`](RtcpHeader.md)\> = `{}` #### Returns @@ -41,55 +24,53 @@ ### count -• **count**: `number` = `0` +> **count**: `number` = `0` -___ +*** ### length -• **length**: `number` = `0` +> **length**: `number` = `0` このパケットの長さは、ヘッダーと任意のパディングを含む32ビットワードから 1を引いたものである -___ +*** ### padding -• **padding**: `boolean` = `false` +> **padding**: `boolean` = `false` -___ +*** ### type -• **type**: `number` = `0` +> **type**: `number` = `0` -___ +*** ### version -• **version**: `number` = `2` +> **version**: `number` = `2` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`RtcpHeader`](RtcpHeader.md) +> `static` **deSerialize**(`buf`): [`RtcpHeader`](RtcpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/doc/classes/RtcpPacketConverter.md b/doc/classes/RtcpPacketConverter.md index 93c8637a4..15b4a717f 100644 --- a/doc/classes/RtcpPacketConverter.md +++ b/doc/classes/RtcpPacketConverter.md @@ -1,23 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpPacketConverter +[**werift**](../README.md) • **Docs** -# Class: RtcpPacketConverter - -## Table of contents - -### Constructors - -- [constructor](RtcpPacketConverter.md#constructor) +*** -### Methods +[werift](../globals.md) / RtcpPacketConverter -- [deSerialize](RtcpPacketConverter.md#deserialize) -- [serialize](RtcpPacketConverter.md#serialize) +# Class: RtcpPacketConverter ## Constructors -### constructor +### new RtcpPacketConverter() -• **new RtcpPacketConverter**(): [`RtcpPacketConverter`](RtcpPacketConverter.md) +> **new RtcpPacketConverter**(): [`RtcpPacketConverter`](RtcpPacketConverter.md) #### Returns @@ -25,34 +18,33 @@ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpPacket`](../modules.md#rtcppacket)[] +> `static` **deSerialize**(`data`): [`RtcpPacket`](../type-aliases/RtcpPacket.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns -[`RtcpPacket`](../modules.md#rtcppacket)[] +[`RtcpPacket`](../type-aliases/RtcpPacket.md)[] -___ +*** -### serialize +### serialize() -▸ **serialize**(`type`, `count`, `payload`, `length`): `Buffer` +> `static` **serialize**(`type`, `count`, `payload`, `length`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `number` | -| `count` | `number` | -| `payload` | `Buffer` | -| `length` | `number` | +• **type**: `number` + +• **count**: `number` + +• **payload**: `Buffer` + +• **length**: `number` #### Returns diff --git a/doc/classes/RtcpPayloadSpecificFeedback.md b/doc/classes/RtcpPayloadSpecificFeedback.md index 57c10c2fa..f17f4e095 100644 --- a/doc/classes/RtcpPayloadSpecificFeedback.md +++ b/doc/classes/RtcpPayloadSpecificFeedback.md @@ -1,35 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpPayloadSpecificFeedback +[**werift**](../README.md) • **Docs** -# Class: RtcpPayloadSpecificFeedback - -## Table of contents - -### Constructors - -- [constructor](RtcpPayloadSpecificFeedback.md#constructor) +*** -### Properties +[werift](../globals.md) / RtcpPayloadSpecificFeedback -- [feedback](RtcpPayloadSpecificFeedback.md#feedback) -- [type](RtcpPayloadSpecificFeedback.md#type) -- [type](RtcpPayloadSpecificFeedback.md#type-1) - -### Methods - -- [serialize](RtcpPayloadSpecificFeedback.md#serialize) -- [deSerialize](RtcpPayloadSpecificFeedback.md#deserialize) +# Class: RtcpPayloadSpecificFeedback ## Constructors -### constructor +### new RtcpPayloadSpecificFeedback() -• **new RtcpPayloadSpecificFeedback**(`props?`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) +> **new RtcpPayloadSpecificFeedback**(`props`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md)\> | +• **props**: `Partial`\<[`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md)\> = `{}` #### Returns @@ -39,42 +24,41 @@ ### feedback -• **feedback**: `Feedback` +> **feedback**: `Feedback` -___ +*** ### type -• `Readonly` **type**: ``206`` +> `readonly` **type**: `206` = `RtcpPayloadSpecificFeedback.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``206`` +> `readonly` `static` **type**: `206` = `206` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) +> `static` **deSerialize**(`data`, `header`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/doc/classes/RtcpReceiverInfo.md b/doc/classes/RtcpReceiverInfo.md index 06419e271..1d0d35d95 100644 --- a/doc/classes/RtcpReceiverInfo.md +++ b/doc/classes/RtcpReceiverInfo.md @@ -1,40 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpReceiverInfo +[**werift**](../README.md) • **Docs** -# Class: RtcpReceiverInfo - -## Table of contents - -### Constructors - -- [constructor](RtcpReceiverInfo.md#constructor) - -### Properties +*** -- [dlsr](RtcpReceiverInfo.md#dlsr) -- [fractionLost](RtcpReceiverInfo.md#fractionlost) -- [highestSequence](RtcpReceiverInfo.md#highestsequence) -- [jitter](RtcpReceiverInfo.md#jitter) -- [lsr](RtcpReceiverInfo.md#lsr) -- [packetsLost](RtcpReceiverInfo.md#packetslost) -- [ssrc](RtcpReceiverInfo.md#ssrc) +[werift](../globals.md) / RtcpReceiverInfo -### Methods - -- [serialize](RtcpReceiverInfo.md#serialize) -- [toJSON](RtcpReceiverInfo.md#tojson) -- [deSerialize](RtcpReceiverInfo.md#deserialize) +# Class: RtcpReceiverInfo ## Constructors -### constructor +### new RtcpReceiverInfo() -• **new RtcpReceiverInfo**(`props?`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) +> **new RtcpReceiverInfo**(`props`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpReceiverInfo`](RtcpReceiverInfo.md)\> | +• **props**: `Partial`\<[`RtcpReceiverInfo`](RtcpReceiverInfo.md)\> = `{}` #### Returns @@ -44,89 +24,105 @@ ### dlsr -• **dlsr**: `number` +> **dlsr**: `number` delay since last SR -___ +*** ### fractionLost -• **fractionLost**: `number` +> **fractionLost**: `number` -___ +*** ### highestSequence -• **highestSequence**: `number` +> **highestSequence**: `number` -___ +*** ### jitter -• **jitter**: `number` +> **jitter**: `number` -___ +*** ### lsr -• **lsr**: `number` +> **lsr**: `number` last SR -___ +*** ### packetsLost -• **packetsLost**: `number` +> **packetsLost**: `number` -___ +*** ### ssrc -• **ssrc**: `number` +> **ssrc**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### dlsr + +> **dlsr**: `number` + +##### fractionLost + +> **fractionLost**: `number` + +##### highestSequence + +> **highestSequence**: `number` + +##### jitter + +> **jitter**: `number` + +##### lsr + +> **lsr**: `number` + +##### packetsLost + +> **packetsLost**: `number` + +##### ssrc -| Name | Type | -| :------ | :------ | -| `dlsr` | `number` | -| `fractionLost` | `number` | -| `highestSequence` | `number` | -| `jitter` | `number` | -| `lsr` | `number` | -| `packetsLost` | `number` | -| `ssrc` | `number` | +> **ssrc**: `number` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) +> `static` **deSerialize**(`data`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/RtcpRrPacket.md b/doc/classes/RtcpRrPacket.md index 0e4fd9f47..479a5a2c5 100644 --- a/doc/classes/RtcpRrPacket.md +++ b/doc/classes/RtcpRrPacket.md @@ -1,36 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpRrPacket +[**werift**](../README.md) • **Docs** -# Class: RtcpRrPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpRrPacket.md#constructor) +*** -### Properties +[werift](../globals.md) / RtcpRrPacket -- [reports](RtcpRrPacket.md#reports) -- [ssrc](RtcpRrPacket.md#ssrc) -- [type](RtcpRrPacket.md#type) -- [type](RtcpRrPacket.md#type-1) - -### Methods - -- [serialize](RtcpRrPacket.md#serialize) -- [deSerialize](RtcpRrPacket.md#deserialize) +# Class: RtcpRrPacket ## Constructors -### constructor +### new RtcpRrPacket() -• **new RtcpRrPacket**(`props?`): [`RtcpRrPacket`](RtcpRrPacket.md) +> **new RtcpRrPacket**(`props`): [`RtcpRrPacket`](RtcpRrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpRrPacket`](RtcpRrPacket.md)\> | +• **props**: `Partial`\<[`RtcpRrPacket`](RtcpRrPacket.md)\> = `{}` #### Returns @@ -40,48 +24,47 @@ ### reports -• **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` +> **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### type -• `Readonly` **type**: ``201`` +> `readonly` **type**: `201` = `RtcpRrPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``201`` +> `readonly` `static` **type**: `201` = `201` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `count`): [`RtcpRrPacket`](RtcpRrPacket.md) +> `static` **deSerialize**(`data`, `count`): [`RtcpRrPacket`](RtcpRrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `count` | `number` | +• **data**: `Buffer` + +• **count**: `number` #### Returns diff --git a/doc/classes/RtcpSenderInfo.md b/doc/classes/RtcpSenderInfo.md index 5a9eb5412..f0472f164 100644 --- a/doc/classes/RtcpSenderInfo.md +++ b/doc/classes/RtcpSenderInfo.md @@ -1,37 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpSenderInfo +[**werift**](../README.md) • **Docs** -# Class: RtcpSenderInfo - -## Table of contents - -### Constructors - -- [constructor](RtcpSenderInfo.md#constructor) - -### Properties +*** -- [ntpTimestamp](RtcpSenderInfo.md#ntptimestamp) -- [octetCount](RtcpSenderInfo.md#octetcount) -- [packetCount](RtcpSenderInfo.md#packetcount) -- [rtpTimestamp](RtcpSenderInfo.md#rtptimestamp) +[werift](../globals.md) / RtcpSenderInfo -### Methods - -- [serialize](RtcpSenderInfo.md#serialize) -- [toJSON](RtcpSenderInfo.md#tojson) -- [deSerialize](RtcpSenderInfo.md#deserialize) +# Class: RtcpSenderInfo ## Constructors -### constructor +### new RtcpSenderInfo() -• **new RtcpSenderInfo**(`props?`): [`RtcpSenderInfo`](RtcpSenderInfo.md) +> **new RtcpSenderInfo**(`props`): [`RtcpSenderInfo`](RtcpSenderInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpSenderInfo`](RtcpSenderInfo.md)\> | +• **props**: `Partial`\<[`RtcpSenderInfo`](RtcpSenderInfo.md)\> = `{}` #### Returns @@ -41,62 +24,63 @@ ### ntpTimestamp -• **ntpTimestamp**: `bigint` +> **ntpTimestamp**: `bigint` -___ +*** ### octetCount -• **octetCount**: `number` +> **octetCount**: `number` -___ +*** ### packetCount -• **packetCount**: `number` +> **packetCount**: `number` -___ +*** ### rtpTimestamp -• **rtpTimestamp**: `number` +> **rtpTimestamp**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### ntpTimestamp + +> **ntpTimestamp**: `number` + +##### rtpTimestamp -| Name | Type | -| :------ | :------ | -| `ntpTimestamp` | `number` | -| `rtpTimestamp` | `number` | +> **rtpTimestamp**: `number` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpSenderInfo`](RtcpSenderInfo.md) +> `static` **deSerialize**(`data`): [`RtcpSenderInfo`](RtcpSenderInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/RtcpSourceDescriptionPacket.md b/doc/classes/RtcpSourceDescriptionPacket.md index 107f3a32b..975daee88 100644 --- a/doc/classes/RtcpSourceDescriptionPacket.md +++ b/doc/classes/RtcpSourceDescriptionPacket.md @@ -1,39 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpSourceDescriptionPacket +[**werift**](../README.md) • **Docs** -# Class: RtcpSourceDescriptionPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpSourceDescriptionPacket.md#constructor) - -### Properties +*** -- [chunks](RtcpSourceDescriptionPacket.md#chunks) -- [type](RtcpSourceDescriptionPacket.md#type) -- [type](RtcpSourceDescriptionPacket.md#type-1) +[werift](../globals.md) / RtcpSourceDescriptionPacket -### Accessors - -- [length](RtcpSourceDescriptionPacket.md#length) - -### Methods - -- [serialize](RtcpSourceDescriptionPacket.md#serialize) -- [deSerialize](RtcpSourceDescriptionPacket.md#deserialize) +# Class: RtcpSourceDescriptionPacket ## Constructors -### constructor +### new RtcpSourceDescriptionPacket() -• **new RtcpSourceDescriptionPacket**(`props`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) +> **new RtcpSourceDescriptionPacket**(`props`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md)\> | +• **props**: `Partial`\<[`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md)\> #### Returns @@ -43,25 +24,25 @@ ### chunks -• **chunks**: [`SourceDescriptionChunk`](SourceDescriptionChunk.md)[] = `[]` +> **chunks**: [`SourceDescriptionChunk`](SourceDescriptionChunk.md)[] = `[]` -___ +*** ### type -• `Readonly` **type**: ``202`` +> `readonly` **type**: `202` = `RtcpSourceDescriptionPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``202`` +> `readonly` `static` **type**: `202` = `202` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -69,26 +50,25 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`payload`, `header`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) +> `static` **deSerialize**(`payload`, `header`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **payload**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/doc/classes/RtcpSrPacket.md b/doc/classes/RtcpSrPacket.md index 67d248794..26c8bb879 100644 --- a/doc/classes/RtcpSrPacket.md +++ b/doc/classes/RtcpSrPacket.md @@ -1,38 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpSrPacket +[**werift**](../README.md) • **Docs** -# Class: RtcpSrPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpSrPacket.md#constructor) - -### Properties +*** -- [reports](RtcpSrPacket.md#reports) -- [senderInfo](RtcpSrPacket.md#senderinfo) -- [ssrc](RtcpSrPacket.md#ssrc) -- [type](RtcpSrPacket.md#type) -- [type](RtcpSrPacket.md#type-1) +[werift](../globals.md) / RtcpSrPacket -### Methods - -- [serialize](RtcpSrPacket.md#serialize) -- [toJSON](RtcpSrPacket.md#tojson) -- [deSerialize](RtcpSrPacket.md#deserialize) +# Class: RtcpSrPacket ## Constructors -### constructor +### new RtcpSrPacket() -• **new RtcpSrPacket**(`props`): [`RtcpSrPacket`](RtcpSrPacket.md) +> **new RtcpSrPacket**(`props`): [`RtcpSrPacket`](RtcpSrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Pick`\<[`RtcpSrPacket`](RtcpSrPacket.md), ``"senderInfo"``\> & `Partial`\<[`RtcpSrPacket`](RtcpSrPacket.md)\> | +• **props**: `Pick`\<[`RtcpSrPacket`](RtcpSrPacket.md), `"senderInfo"`\> & `Partial`\<[`RtcpSrPacket`](RtcpSrPacket.md)\> #### Returns @@ -42,72 +24,83 @@ ### reports -• **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` +> **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` -___ +*** ### senderInfo -• **senderInfo**: [`RtcpSenderInfo`](RtcpSenderInfo.md) +> **senderInfo**: [`RtcpSenderInfo`](RtcpSenderInfo.md) -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### type -• `Readonly` **type**: ``200`` +> `readonly` **type**: `200` = `RtcpSrPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``200`` +> `readonly` `static` **type**: `200` = `200` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### reports + +> **reports**: `object`[] -| Name | Type | -| :------ | :------ | -| `reports` | \{ `dlsr`: `number` ; `fractionLost`: `number` ; `highestSequence`: `number` ; `jitter`: `number` ; `lsr`: `number` ; `packetsLost`: `number` ; `ssrc`: `number` }[] | -| `senderInfo` | \{ `ntpTimestamp`: `number` ; `rtpTimestamp`: `number` } | -| `senderInfo.ntpTimestamp` | `number` | -| `senderInfo.rtpTimestamp` | `number` | -| `ssrc` | `number` | +##### senderInfo -___ +> **senderInfo**: `object` -### deSerialize +##### senderInfo.ntpTimestamp -▸ **deSerialize**(`payload`, `count`): [`RtcpSrPacket`](RtcpSrPacket.md) +> **ntpTimestamp**: `number` + +##### senderInfo.rtpTimestamp + +> **rtpTimestamp**: `number` + +##### ssrc + +> **ssrc**: `number` + +*** + +### deSerialize() + +> `static` **deSerialize**(`payload`, `count`): [`RtcpSrPacket`](RtcpSrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `count` | `number` | +• **payload**: `Buffer` + +• **count**: `number` #### Returns diff --git a/doc/classes/RtcpTransportLayerFeedback.md b/doc/classes/RtcpTransportLayerFeedback.md index 5e47d1e54..278928279 100644 --- a/doc/classes/RtcpTransportLayerFeedback.md +++ b/doc/classes/RtcpTransportLayerFeedback.md @@ -1,36 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtcpTransportLayerFeedback +[**werift**](../README.md) • **Docs** -# Class: RtcpTransportLayerFeedback - -## Table of contents - -### Constructors - -- [constructor](RtcpTransportLayerFeedback.md#constructor) - -### Properties +*** -- [feedback](RtcpTransportLayerFeedback.md#feedback) -- [header](RtcpTransportLayerFeedback.md#header) -- [type](RtcpTransportLayerFeedback.md#type) -- [type](RtcpTransportLayerFeedback.md#type-1) +[werift](../globals.md) / RtcpTransportLayerFeedback -### Methods - -- [serialize](RtcpTransportLayerFeedback.md#serialize) -- [deSerialize](RtcpTransportLayerFeedback.md#deserialize) +# Class: RtcpTransportLayerFeedback ## Constructors -### constructor +### new RtcpTransportLayerFeedback() -• **new RtcpTransportLayerFeedback**(`props?`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) +> **new RtcpTransportLayerFeedback**(`props`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md)\> | +• **props**: `Partial`\<[`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md)\> = `{}` #### Returns @@ -40,48 +24,47 @@ ### feedback -• **feedback**: `Feedback` +> **feedback**: `Feedback` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### type -• `Readonly` **type**: ``205`` +> `readonly` **type**: `205` = `RtcpTransportLayerFeedback.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``205`` +> `readonly` `static` **type**: `205` = `205` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) +> `static` **deSerialize**(`data`, `header`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/doc/classes/RtpBuilder.md b/doc/classes/RtpBuilder.md index fc3fdc5d9..b7672d1a7 100644 --- a/doc/classes/RtpBuilder.md +++ b/doc/classes/RtpBuilder.md @@ -1,35 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / RtpBuilder +[**werift**](../README.md) • **Docs** -# Class: RtpBuilder - -## Table of contents - -### Constructors - -- [constructor](RtpBuilder.md#constructor) - -### Properties +*** -- [sequenceNumber](RtpBuilder.md#sequencenumber) -- [timestamp](RtpBuilder.md#timestamp) +[werift](../globals.md) / RtpBuilder -### Methods - -- [create](RtpBuilder.md#create) +# Class: RtpBuilder ## Constructors -### constructor +### new RtpBuilder() -• **new RtpBuilder**(`props`): [`RtpBuilder`](RtpBuilder.md) +> **new RtpBuilder**(`props`): [`RtpBuilder`](RtpBuilder.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.between` | `number` | -| `props.clockRate` | `number` | +• **props** + +• **props.between**: `number` + +• **props.clockRate**: `number` #### Returns @@ -39,25 +28,23 @@ ### sequenceNumber -• **sequenceNumber**: `number` +> **sequenceNumber**: `number` -___ +*** ### timestamp -• **timestamp**: `number` +> **timestamp**: `number` ## Methods -### create +### create() -▸ **create**(`payload`): [`RtpPacket`](RtpPacket.md) +> **create**(`payload`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | +• **payload**: `Buffer` #### Returns diff --git a/doc/classes/RtpHeader.md b/doc/classes/RtpHeader.md index 7eb189fc0..5ce430a34 100644 --- a/doc/classes/RtpHeader.md +++ b/doc/classes/RtpHeader.md @@ -1,51 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RtpHeader +[**werift**](../README.md) • **Docs** -# Class: RtpHeader - -## Table of contents - -### Constructors - -- [constructor](RtpHeader.md#constructor) - -### Properties +*** -- [csrc](RtpHeader.md#csrc) -- [csrcLength](RtpHeader.md#csrclength) -- [extension](RtpHeader.md#extension) -- [extensionLength](RtpHeader.md#extensionlength) -- [extensionProfile](RtpHeader.md#extensionprofile) -- [extensions](RtpHeader.md#extensions) -- [marker](RtpHeader.md#marker) -- [padding](RtpHeader.md#padding) -- [paddingSize](RtpHeader.md#paddingsize) -- [payloadOffset](RtpHeader.md#payloadoffset) -- [payloadType](RtpHeader.md#payloadtype) -- [sequenceNumber](RtpHeader.md#sequencenumber) -- [ssrc](RtpHeader.md#ssrc) -- [timestamp](RtpHeader.md#timestamp) -- [version](RtpHeader.md#version) +[werift](../globals.md) / RtpHeader -### Accessors - -- [serializeSize](RtpHeader.md#serializesize) - -### Methods - -- [serialize](RtpHeader.md#serialize) -- [deSerialize](RtpHeader.md#deserialize) +# Class: RtpHeader ## Constructors -### constructor +### new RtpHeader() -• **new RtpHeader**(`props?`): [`RtpHeader`](RtpHeader.md) +> **new RtpHeader**(`props`): [`RtpHeader`](RtpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtpHeader`](RtpHeader.md)\> | +• **props**: `Partial`\<[`RtpHeader`](RtpHeader.md)\> = `{}` #### Returns @@ -55,103 +24,103 @@ ### csrc -• **csrc**: `number`[] = `[]` +> **csrc**: `number`[] = `[]` -___ +*** ### csrcLength -• **csrcLength**: `number` = `0` +> **csrcLength**: `number` = `0` -___ +*** ### extension -• **extension**: `boolean` = `false` +> **extension**: `boolean` = `false` -___ +*** -### extensionLength +### extensionLength? -• `Optional` **extensionLength**: `number` +> `optional` **extensionLength**: `number` deserialize only -___ +*** ### extensionProfile -• **extensionProfile**: `ExtensionProfile` = `ExtensionProfiles.OneByte` +> **extensionProfile**: `ExtensionProfile` = `ExtensionProfiles.OneByte` -___ +*** ### extensions -• **extensions**: [`Extension`](../modules.md#extension)[] = `[]` +> **extensions**: [`Extension`](../type-aliases/Extension.md)[] = `[]` -___ +*** ### marker -• **marker**: `boolean` = `false` +> **marker**: `boolean` = `false` -___ +*** ### padding -• **padding**: `boolean` = `false` +> **padding**: `boolean` = `false` -___ +*** ### paddingSize -• **paddingSize**: `number` = `0` +> **paddingSize**: `number` = `0` -___ +*** ### payloadOffset -• **payloadOffset**: `number` = `0` +> **payloadOffset**: `number` = `0` -___ +*** ### payloadType -• **payloadType**: `number` = `0` +> **payloadType**: `number` = `0` -___ +*** ### sequenceNumber -• **sequenceNumber**: `number` = `0` +> **sequenceNumber**: `number` = `0` 16bit, 初期値はランダムである必要があります -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### timestamp -• **timestamp**: `number` = `0` +> **timestamp**: `number` = `0` 32bit microsec (milli/1000), 初期値はランダムである必要があります -___ +*** ### version -• **version**: `number` = `2` +> **version**: `number` = `2` ## Accessors ### serializeSize -• `get` **serializeSize**(): `number` +> `get` **serializeSize**(): `number` #### Returns @@ -159,31 +128,27 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(`size`): `Buffer` +> **serialize**(`size`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | +• **size**: `number` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`rawPacket`): [`RtpHeader`](RtpHeader.md) +> `static` **deSerialize**(`rawPacket`): [`RtpHeader`](RtpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `rawPacket` | `Buffer` | +• **rawPacket**: `Buffer` #### Returns diff --git a/doc/classes/RtpPacket.md b/doc/classes/RtpPacket.md index 19635e8a8..4ce2f73ef 100644 --- a/doc/classes/RtpPacket.md +++ b/doc/classes/RtpPacket.md @@ -1,41 +1,22 @@ -[werift](../README.md) / [Exports](../modules.md) / RtpPacket +[**werift**](../README.md) • **Docs** -# Class: RtpPacket - -## Table of contents - -### Constructors - -- [constructor](RtpPacket.md#constructor) - -### Properties - -- [header](RtpPacket.md#header) -- [payload](RtpPacket.md#payload) - -### Accessors +*** -- [serializeSize](RtpPacket.md#serializesize) +[werift](../globals.md) / RtpPacket -### Methods - -- [clear](RtpPacket.md#clear) -- [clone](RtpPacket.md#clone) -- [serialize](RtpPacket.md#serialize) -- [deSerialize](RtpPacket.md#deserialize) +# Class: RtpPacket ## Constructors -### constructor +### new RtpPacket() -• **new RtpPacket**(`header`, `payload`): [`RtpPacket`](RtpPacket.md) +> **new RtpPacket**(`header`, `payload`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | -| `payload` | `Buffer` | +• **header**: [`RtpHeader`](RtpHeader.md) + +• **payload**: `Buffer` #### Returns @@ -45,19 +26,19 @@ ### header -• **header**: [`RtpHeader`](RtpHeader.md) +> **header**: [`RtpHeader`](RtpHeader.md) -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Accessors ### serializeSize -• `get` **serializeSize**(): `number` +> `get` **serializeSize**(): `number` #### Returns @@ -65,45 +46,43 @@ ___ ## Methods -### clear +### clear() -▸ **clear**(): `void` +> **clear**(): `void` #### Returns `void` -___ +*** -### clone +### clone() -▸ **clone**(): [`RtpPacket`](RtpPacket.md) +> **clone**(): [`RtpPacket`](RtpPacket.md) #### Returns [`RtpPacket`](RtpPacket.md) -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`RtpPacket`](RtpPacket.md) +> `static` **deSerialize**(`buf`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/doc/classes/RunLengthChunk.md b/doc/classes/RunLengthChunk.md index e6242b8be..eb090dd5d 100644 --- a/doc/classes/RunLengthChunk.md +++ b/doc/classes/RunLengthChunk.md @@ -1,36 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / RunLengthChunk +[**werift**](../README.md) • **Docs** -# Class: RunLengthChunk - -## Table of contents - -### Constructors - -- [constructor](RunLengthChunk.md#constructor) +*** -### Properties +[werift](../globals.md) / RunLengthChunk -- [packetStatus](RunLengthChunk.md#packetstatus) -- [runLength](RunLengthChunk.md#runlength) -- [type](RunLengthChunk.md#type) - -### Methods - -- [results](RunLengthChunk.md#results) -- [serialize](RunLengthChunk.md#serialize) -- [deSerialize](RunLengthChunk.md#deserialize) +# Class: RunLengthChunk ## Constructors -### constructor +### new RunLengthChunk() -• **new RunLengthChunk**(`props?`): [`RunLengthChunk`](RunLengthChunk.md) +> **new RunLengthChunk**(`props`): [`RunLengthChunk`](RunLengthChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RunLengthChunk`](RunLengthChunk.md)\> | +• **props**: `Partial`\<[`RunLengthChunk`](RunLengthChunk.md)\> = `{}` #### Returns @@ -40,59 +24,55 @@ ### packetStatus -• **packetStatus**: [`PacketStatus`](../enums/PacketStatus.md) +> **packetStatus**: [`PacketStatus`](../enumerations/PacketStatus.md) -___ +*** ### runLength -• **runLength**: `number` +> **runLength**: `number` 13bit -___ +*** ### type -• **type**: [`TypeTCCRunLengthChunk`](../enums/PacketChunk.md#typetccrunlengthchunk) +> **type**: [`TypeTCCRunLengthChunk`](../enumerations/PacketChunk.md#typetccrunlengthchunk) ## Methods -### results +### results() -▸ **results**(`currentSequenceNumber`): [`PacketResult`](PacketResult.md)[] +> **results**(`currentSequenceNumber`): [`PacketResult`](PacketResult.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `currentSequenceNumber` | `number` | +• **currentSequenceNumber**: `number` #### Returns [`PacketResult`](PacketResult.md)[] -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RunLengthChunk`](RunLengthChunk.md) +> `static` **deSerialize**(`data`): [`RunLengthChunk`](RunLengthChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/SessionDescription.md b/doc/classes/SessionDescription.md index 34565950f..9988a7b4f 100644 --- a/doc/classes/SessionDescription.md +++ b/doc/classes/SessionDescription.md @@ -1,47 +1,16 @@ -[werift](../README.md) / [Exports](../modules.md) / SessionDescription +[**werift**](../README.md) • **Docs** -# Class: SessionDescription - -## Table of contents - -### Constructors - -- [constructor](SessionDescription.md#constructor) - -### Properties +*** -- [dtlsFingerprints](SessionDescription.md#dtlsfingerprints) -- [dtlsRole](SessionDescription.md#dtlsrole) -- [extMapAllowMixed](SessionDescription.md#extmapallowmixed) -- [group](SessionDescription.md#group) -- [host](SessionDescription.md#host) -- [iceLite](SessionDescription.md#icelite) -- [iceOptions](SessionDescription.md#iceoptions) -- [icePassword](SessionDescription.md#icepassword) -- [iceUsernameFragment](SessionDescription.md#iceusernamefragment) -- [media](SessionDescription.md#media) -- [msidSemantic](SessionDescription.md#msidsemantic) -- [name](SessionDescription.md#name) -- [origin](SessionDescription.md#origin) -- [time](SessionDescription.md#time) -- [type](SessionDescription.md#type) -- [version](SessionDescription.md#version) +[werift](../globals.md) / SessionDescription -### Accessors - -- [string](SessionDescription.md#string) - -### Methods - -- [toJSON](SessionDescription.md#tojson) -- [webrtcTrackId](SessionDescription.md#webrtctrackid) -- [parse](SessionDescription.md#parse) +# Class: SessionDescription ## Constructors -### constructor +### new SessionDescription() -• **new SessionDescription**(): [`SessionDescription`](SessionDescription.md) +> **new SessionDescription**(): [`SessionDescription`](SessionDescription.md) #### Returns @@ -51,103 +20,103 @@ ### dtlsFingerprints -• **dtlsFingerprints**: [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] = `[]` +> **dtlsFingerprints**: [`RTCDtlsFingerprint`](RTCDtlsFingerprint.md)[] = `[]` -___ +*** ### dtlsRole -• **dtlsRole**: [`DtlsRole`](../modules.md#dtlsrole) +> **dtlsRole**: [`DtlsRole`](../type-aliases/DtlsRole.md) -___ +*** ### extMapAllowMixed -• **extMapAllowMixed**: `boolean` = `true` +> **extMapAllowMixed**: `boolean` = `true` -___ +*** ### group -• **group**: [`GroupDescription`](GroupDescription.md)[] = `[]` +> **group**: [`GroupDescription`](GroupDescription.md)[] = `[]` -___ +*** -### host +### host? -• `Optional` **host**: `string` +> `optional` **host**: `string` -___ +*** ### iceLite -• **iceLite**: `boolean` +> **iceLite**: `boolean` -___ +*** ### iceOptions -• **iceOptions**: `string` +> **iceOptions**: `string` -___ +*** ### icePassword -• **icePassword**: `string` +> **icePassword**: `string` -___ +*** ### iceUsernameFragment -• **iceUsernameFragment**: `string` +> **iceUsernameFragment**: `string` -___ +*** ### media -• **media**: [`MediaDescription`](MediaDescription.md)[] = `[]` +> **media**: [`MediaDescription`](MediaDescription.md)[] = `[]` -___ +*** ### msidSemantic -• **msidSemantic**: [`GroupDescription`](GroupDescription.md)[] = `[]` +> **msidSemantic**: [`GroupDescription`](GroupDescription.md)[] = `[]` -___ +*** ### name -• **name**: `string` = `"-"` +> **name**: `string` = `"-"` -___ +*** -### origin +### origin? -• `Optional` **origin**: `string` +> `optional` **origin**: `string` -___ +*** ### time -• **time**: `string` = `"0 0"` +> **time**: `string` = `"0 0"` -___ +*** ### type -• **type**: ``"offer"`` \| ``"answer"`` +> **type**: `"offer"` \| `"answer"` -___ +*** ### version -• **version**: `number` = `0` +> **version**: `number` = `0` ## Accessors ### string -• `get` **string**(): `string` +> `get` **string**(): `string` #### Returns @@ -155,41 +124,37 @@ ___ ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): [`RTCSessionDescription`](RTCSessionDescription.md) +> **toJSON**(): [`RTCSessionDescription`](RTCSessionDescription.md) #### Returns [`RTCSessionDescription`](RTCSessionDescription.md) -___ +*** -### webrtcTrackId +### webrtcTrackId() -▸ **webrtcTrackId**(`media`): `undefined` \| `string` +> **webrtcTrackId**(`media`): `undefined` \| `string` #### Parameters -| Name | Type | -| :------ | :------ | -| `media` | [`MediaDescription`](MediaDescription.md) | +• **media**: [`MediaDescription`](MediaDescription.md) #### Returns `undefined` \| `string` -___ +*** -### parse +### parse() -▸ **parse**(`sdp`): [`SessionDescription`](SessionDescription.md) +> `static` **parse**(`sdp`): [`SessionDescription`](SessionDescription.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `sdp` | `string` | +• **sdp**: `string` #### Returns diff --git a/doc/classes/SourceDescriptionChunk.md b/doc/classes/SourceDescriptionChunk.md index f23b6e603..935fe6553 100644 --- a/doc/classes/SourceDescriptionChunk.md +++ b/doc/classes/SourceDescriptionChunk.md @@ -1,38 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / SourceDescriptionChunk +[**werift**](../README.md) • **Docs** -# Class: SourceDescriptionChunk - -## Table of contents - -### Constructors - -- [constructor](SourceDescriptionChunk.md#constructor) - -### Properties +*** -- [items](SourceDescriptionChunk.md#items) -- [source](SourceDescriptionChunk.md#source) +[werift](../globals.md) / SourceDescriptionChunk -### Accessors - -- [length](SourceDescriptionChunk.md#length) - -### Methods - -- [serialize](SourceDescriptionChunk.md#serialize) -- [deSerialize](SourceDescriptionChunk.md#deserialize) +# Class: SourceDescriptionChunk ## Constructors -### constructor +### new SourceDescriptionChunk() -• **new SourceDescriptionChunk**(`props?`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) +> **new SourceDescriptionChunk**(`props`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`SourceDescriptionChunk`](SourceDescriptionChunk.md)\> | +• **props**: `Partial`\<[`SourceDescriptionChunk`](SourceDescriptionChunk.md)\> = `{}` #### Returns @@ -42,19 +24,19 @@ ### items -• **items**: [`SourceDescriptionItem`](SourceDescriptionItem.md)[] = `[]` +> **items**: [`SourceDescriptionItem`](SourceDescriptionItem.md)[] = `[]` -___ +*** ### source -• **source**: `number` +> **source**: `number` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -62,25 +44,23 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) +> `static` **deSerialize**(`data`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/SourceDescriptionItem.md b/doc/classes/SourceDescriptionItem.md index 19affa228..e9f8a314f 100644 --- a/doc/classes/SourceDescriptionItem.md +++ b/doc/classes/SourceDescriptionItem.md @@ -1,38 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / SourceDescriptionItem +[**werift**](../README.md) • **Docs** -# Class: SourceDescriptionItem - -## Table of contents - -### Constructors - -- [constructor](SourceDescriptionItem.md#constructor) - -### Properties +*** -- [text](SourceDescriptionItem.md#text) -- [type](SourceDescriptionItem.md#type) +[werift](../globals.md) / SourceDescriptionItem -### Accessors - -- [length](SourceDescriptionItem.md#length) - -### Methods - -- [serialize](SourceDescriptionItem.md#serialize) -- [deSerialize](SourceDescriptionItem.md#deserialize) +# Class: SourceDescriptionItem ## Constructors -### constructor +### new SourceDescriptionItem() -• **new SourceDescriptionItem**(`props`): [`SourceDescriptionItem`](SourceDescriptionItem.md) +> **new SourceDescriptionItem**(`props`): [`SourceDescriptionItem`](SourceDescriptionItem.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`SourceDescriptionItem`](SourceDescriptionItem.md)\> | +• **props**: `Partial`\<[`SourceDescriptionItem`](SourceDescriptionItem.md)\> #### Returns @@ -42,19 +24,19 @@ ### text -• **text**: `string` +> **text**: `string` -___ +*** ### type -• **type**: `number` +> **type**: `number` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -62,25 +44,23 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`SourceDescriptionItem`](SourceDescriptionItem.md) +> `static` **deSerialize**(`data`): [`SourceDescriptionItem`](SourceDescriptionItem.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/SrtcpSession.md b/doc/classes/SrtcpSession.md index cfe420520..3a532000f 100644 --- a/doc/classes/SrtcpSession.md +++ b/doc/classes/SrtcpSession.md @@ -1,43 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / SrtcpSession +[**werift**](../README.md) • **Docs** -# Class: SrtcpSession - -## Hierarchy - -- `Session`\<`SrtcpContext`\> - - ↳ **`SrtcpSession`** +*** -## Table of contents +[werift](../globals.md) / SrtcpSession -### Constructors - -- [constructor](SrtcpSession.md#constructor) - -### Properties - -- [config](SrtcpSession.md#config) -- [localContext](SrtcpSession.md#localcontext) -- [onData](SrtcpSession.md#ondata) -- [remoteContext](SrtcpSession.md#remotecontext) +# Class: SrtcpSession -### Methods +## Extends -- [decrypt](SrtcpSession.md#decrypt) -- [encrypt](SrtcpSession.md#encrypt) -- [start](SrtcpSession.md#start) +- `Session`\<`SrtcpContext`\> ## Constructors -### constructor +### new SrtcpSession() -• **new SrtcpSession**(`config`): [`SrtcpSession`](SrtcpSession.md) +> **new SrtcpSession**(`config`): [`SrtcpSession`](SrtcpSession.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | `Config` | +• **config**: `Config` #### Returns @@ -45,105 +26,97 @@ #### Overrides -Session\<SrtcpContext\>.constructor +`Session.constructor` ## Properties ### config -• **config**: `Config` +> **config**: `Config` -___ +*** ### localContext -• **localContext**: `SrtcpContext` +> **localContext**: `SrtcpContext` #### Inherited from -Session.localContext - -___ +`Session.localContext` -### onData +*** -• `Optional` **onData**: (`buf`: `Buffer`) => `void` +### onData()? -#### Type declaration +> `optional` **onData**: (`buf`) => `void` -▸ (`buf`): `void` - -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` -##### Returns +#### Returns `void` #### Inherited from -Session.onData +`Session.onData` -___ +*** ### remoteContext -• **remoteContext**: `SrtcpContext` +> **remoteContext**: `SrtcpContext` #### Inherited from -Session.remoteContext +`Session.remoteContext` ## Methods -### decrypt +### decrypt() -▸ **decrypt**(`buf`): `Buffer` +> **decrypt**(`buf`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns `Buffer` -___ +*** -### encrypt +### encrypt() -▸ **encrypt**(`rawRtcp`): `Buffer` +> **encrypt**(`rawRtcp`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `rawRtcp` | `Buffer` | +• **rawRtcp**: `Buffer` #### Returns `Buffer` -___ +*** -### start +### start() -▸ **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` +> **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `localMasterKey` | `Buffer` | -| `localMasterSalt` | `Buffer` | -| `remoteMasterKey` | `Buffer` | -| `remoteMasterSalt` | `Buffer` | -| `profile` | `number` | +• **localMasterKey**: `Buffer` + +• **localMasterSalt**: `Buffer` + +• **remoteMasterKey**: `Buffer` + +• **remoteMasterSalt**: `Buffer` + +• **profile**: `number` #### Returns @@ -151,4 +124,4 @@ ___ #### Inherited from -Session.start +`Session.start` diff --git a/doc/classes/SrtpSession.md b/doc/classes/SrtpSession.md index f3b29e889..861d8c9cd 100644 --- a/doc/classes/SrtpSession.md +++ b/doc/classes/SrtpSession.md @@ -1,43 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / SrtpSession +[**werift**](../README.md) • **Docs** -# Class: SrtpSession - -## Hierarchy - -- `Session`\<`SrtpContext`\> - - ↳ **`SrtpSession`** - -## Table of contents +*** -### Constructors +[werift](../globals.md) / SrtpSession -- [constructor](SrtpSession.md#constructor) - -### Properties - -- [config](SrtpSession.md#config) -- [localContext](SrtpSession.md#localcontext) -- [onData](SrtpSession.md#ondata) -- [remoteContext](SrtpSession.md#remotecontext) +# Class: SrtpSession -### Methods +## Extends -- [decrypt](SrtpSession.md#decrypt) -- [encrypt](SrtpSession.md#encrypt) -- [start](SrtpSession.md#start) +- `Session`\<`SrtpContext`\> ## Constructors -### constructor +### new SrtpSession() -• **new SrtpSession**(`config`): [`SrtpSession`](SrtpSession.md) +> **new SrtpSession**(`config`): [`SrtpSession`](SrtpSession.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | `Config` | +• **config**: `Config` #### Returns @@ -45,106 +26,99 @@ #### Overrides -Session\<SrtpContext\>.constructor +`Session.constructor` ## Properties ### config -• **config**: `Config` +> **config**: `Config` -___ +*** ### localContext -• **localContext**: `SrtpContext` +> **localContext**: `SrtpContext` #### Inherited from -Session.localContext - -___ - -### onData +`Session.localContext` -• `Optional` **onData**: (`buf`: `Buffer`) => `void` +*** -#### Type declaration +### onData()? -▸ (`buf`): `void` +> `optional` **onData**: (`buf`) => `void` -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` -##### Returns +#### Returns `void` #### Inherited from -Session.onData +`Session.onData` -___ +*** ### remoteContext -• **remoteContext**: `SrtpContext` +> **remoteContext**: `SrtpContext` #### Inherited from -Session.remoteContext +`Session.remoteContext` ## Methods -### decrypt +### decrypt() -▸ **decrypt**(`buf`): `Buffer` +> **decrypt**(`buf`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns `Buffer` -___ +*** -### encrypt +### encrypt() -▸ **encrypt**(`payload`, `header`): `Buffer` +> **encrypt**(`payload`, `header`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **payload**: `Buffer` + +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns `Buffer` -___ +*** -### start +### start() -▸ **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` +> **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `localMasterKey` | `Buffer` | -| `localMasterSalt` | `Buffer` | -| `remoteMasterKey` | `Buffer` | -| `remoteMasterSalt` | `Buffer` | -| `profile` | `number` | +• **localMasterKey**: `Buffer` + +• **localMasterSalt**: `Buffer` + +• **remoteMasterKey**: `Buffer` + +• **remoteMasterSalt**: `Buffer` + +• **profile**: `number` #### Returns @@ -152,4 +126,4 @@ ___ #### Inherited from -Session.start +`Session.start` diff --git a/doc/classes/SsrcDescription.md b/doc/classes/SsrcDescription.md index 5fa3272c0..bb979961e 100644 --- a/doc/classes/SsrcDescription.md +++ b/doc/classes/SsrcDescription.md @@ -1,32 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / SsrcDescription +[**werift**](../README.md) • **Docs** -# Class: SsrcDescription - -## Table of contents - -### Constructors +*** -- [constructor](SsrcDescription.md#constructor) +[werift](../globals.md) / SsrcDescription -### Properties - -- [cname](SsrcDescription.md#cname) -- [label](SsrcDescription.md#label) -- [msLabel](SsrcDescription.md#mslabel) -- [msid](SsrcDescription.md#msid) -- [ssrc](SsrcDescription.md#ssrc) +# Class: SsrcDescription ## Constructors -### constructor +### new SsrcDescription() -• **new SsrcDescription**(`props`): [`SsrcDescription`](SsrcDescription.md) +> **new SsrcDescription**(`props`): [`SsrcDescription`](SsrcDescription.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`SsrcDescription`](SsrcDescription.md)\> | +• **props**: `Partial`\<[`SsrcDescription`](SsrcDescription.md)\> #### Returns @@ -34,30 +22,30 @@ ## Properties -### cname +### cname? -• `Optional` **cname**: `string` +> `optional` **cname**: `string` -___ +*** -### label +### label? -• `Optional` **label**: `string` +> `optional` **label**: `string` -___ +*** -### msLabel +### msLabel? -• `Optional` **msLabel**: `string` +> `optional` **msLabel**: `string` -___ +*** -### msid +### msid? -• `Optional` **msid**: `string` +> `optional` **msid**: `string` -___ +*** ### ssrc -• **ssrc**: `number` +> **ssrc**: `number` diff --git a/doc/classes/StatusVectorChunk.md b/doc/classes/StatusVectorChunk.md index 28bde218e..571f67b4e 100644 --- a/doc/classes/StatusVectorChunk.md +++ b/doc/classes/StatusVectorChunk.md @@ -1,35 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / StatusVectorChunk +[**werift**](../README.md) • **Docs** -# Class: StatusVectorChunk - -## Table of contents - -### Constructors - -- [constructor](StatusVectorChunk.md#constructor) +*** -### Properties +[werift](../globals.md) / StatusVectorChunk -- [symbolList](StatusVectorChunk.md#symbollist) -- [symbolSize](StatusVectorChunk.md#symbolsize) -- [type](StatusVectorChunk.md#type) - -### Methods - -- [serialize](StatusVectorChunk.md#serialize) -- [deSerialize](StatusVectorChunk.md#deserialize) +# Class: StatusVectorChunk ## Constructors -### constructor +### new StatusVectorChunk() -• **new StatusVectorChunk**(`props?`): [`StatusVectorChunk`](StatusVectorChunk.md) +> **new StatusVectorChunk**(`props`): [`StatusVectorChunk`](StatusVectorChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`StatusVectorChunk`](StatusVectorChunk.md)\> | +• **props**: `Partial`\<[`StatusVectorChunk`](StatusVectorChunk.md)\> = `{}` #### Returns @@ -39,41 +24,39 @@ ### symbolList -• **symbolList**: `number`[] = `[]` +> **symbolList**: `number`[] = `[]` -___ +*** ### symbolSize -• **symbolSize**: `number` +> **symbolSize**: `number` -___ +*** ### type -• **type**: `number` +> **type**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`StatusVectorChunk`](StatusVectorChunk.md) +> `static` **deSerialize**(`data`): [`StatusVectorChunk`](StatusVectorChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/doc/classes/StunOverTurnProtocol.md b/doc/classes/StunOverTurnProtocol.md new file mode 100644 index 000000000..a8a50a8ea --- /dev/null +++ b/doc/classes/StunOverTurnProtocol.md @@ -0,0 +1,149 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / StunOverTurnProtocol + +# Class: StunOverTurnProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new StunOverTurnProtocol() + +> **new StunOverTurnProtocol**(`turn`, `ice`): [`StunOverTurnProtocol`](StunOverTurnProtocol.md) + +#### Parameters + +• **turn**: [`TurnProtocol`](TurnProtocol.md) + +• **ice**: [`Connection`](Connection.md) + +#### Returns + +[`StunOverTurnProtocol`](StunOverTurnProtocol.md) + +## Properties + +### localCandidate + +> **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### turn + +> **turn**: [`TurnProtocol`](TurnProtocol.md) + +*** + +### type + +> `readonly` **type**: `string` = `StunOverTurnProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### type + +> `static` **type**: `string` = `"turn"` + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionMade() + +> **connectionMade**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### request() + +> **request**(`request`, `addr`, `integrityKey`?): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **integrityKey?**: `Buffer` + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/doc/classes/StunProtocol.md b/doc/classes/StunProtocol.md new file mode 100644 index 000000000..2024f188a --- /dev/null +++ b/doc/classes/StunProtocol.md @@ -0,0 +1,219 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / StunProtocol + +# Class: StunProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new StunProtocol() + +> **new StunProtocol**(`receiver`?): [`StunProtocol`](StunProtocol.md) + +#### Parameters + +• **receiver?**: [`Connection`](Connection.md) + +#### Returns + +[`StunProtocol`](StunProtocol.md) + +## Properties + +### localAddress? + +> `optional` **localAddress**: `string` + +*** + +### localCandidate? + +> `optional` **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### receiver? + +> `optional` **receiver**: [`Connection`](Connection.md) + +*** + +### sentMessage? + +> `optional` **sentMessage**: [`Message`](Message.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sentMessage`](../interfaces/Protocol.md#sentmessage) + +*** + +### transactions + +> **transactions**: `object` = `{}` + +#### Index Signature + + \[`key`: `string`\]: `Transaction` + +*** + +### transport + +> **transport**: [`UdpTransport`](UdpTransport.md) + +*** + +### type + +> `readonly` **type**: `"stun"` = `StunProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### type + +> `readonly` `static` **type**: `"stun"` = `"stun"` + +## Accessors + +### transactionsKeys + +> `get` **transactionsKeys**(): `string`[] + +#### Returns + +`string`[] + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionLost() + +> **connectionLost**(): `void` + +#### Returns + +`void` + +*** + +### connectionMade() + +> **connectionMade**(`useIpv4`, `portRange`?, `interfaceAddresses`?): `Promise`\<`void`\> + +#### Parameters + +• **useIpv4**: `boolean` + +• **portRange?**: [`number`, `number`] + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### getExtraInfo() + +> **getExtraInfo**(): readonly [`string`, `number`] + +#### Returns + +readonly [`string`, `number`] + +*** + +### request() + +> **request**(`request`, `addr`, `integrityKey`?, `retransmissions`?): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **integrityKey?**: `Buffer` + +• **retransmissions?**: `number` + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/doc/classes/TcpTransport.md b/doc/classes/TcpTransport.md new file mode 100644 index 000000000..a156b888e --- /dev/null +++ b/doc/classes/TcpTransport.md @@ -0,0 +1,95 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / TcpTransport + +# Class: TcpTransport + +## Implements + +- [`Transport`](../interfaces/Transport.md) + +## Properties + +### closed + +> **closed**: `boolean` = `false` + +*** + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`onData`](../interfaces/Transport.md#ondata) + +*** + +### type + +> `readonly` **type**: `"tcp"` = `"tcp"` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`type`](../interfaces/Transport.md#type) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`close`](../interfaces/Transport.md#close) + +*** + +### send() + +> **send**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`send`](../interfaces/Transport.md#send) + +*** + +### init() + +> `static` **init**(`addr`): `Promise`\<[`TcpTransport`](TcpTransport.md)\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[`TcpTransport`](TcpTransport.md)\> diff --git a/doc/classes/TransportWideCC.md b/doc/classes/TransportWideCC.md index 474f6bcce..996c43117 100644 --- a/doc/classes/TransportWideCC.md +++ b/doc/classes/TransportWideCC.md @@ -1,48 +1,20 @@ -[werift](../README.md) / [Exports](../modules.md) / TransportWideCC +[**werift**](../README.md) • **Docs** -# Class: TransportWideCC - -## Table of contents - -### Constructors - -- [constructor](TransportWideCC.md#constructor) - -### Properties - -- [baseSequenceNumber](TransportWideCC.md#basesequencenumber) -- [count](TransportWideCC.md#count) -- [fbPktCount](TransportWideCC.md#fbpktcount) -- [header](TransportWideCC.md#header) -- [length](TransportWideCC.md#length) -- [mediaSourceSsrc](TransportWideCC.md#mediasourcessrc) -- [packetChunks](TransportWideCC.md#packetchunks) -- [packetStatusCount](TransportWideCC.md#packetstatuscount) -- [recvDeltas](TransportWideCC.md#recvdeltas) -- [referenceTime](TransportWideCC.md#referencetime) -- [senderSsrc](TransportWideCC.md#senderssrc) -- [count](TransportWideCC.md#count-1) +*** -### Accessors +[werift](../globals.md) / TransportWideCC -- [packetResults](TransportWideCC.md#packetresults) - -### Methods - -- [serialize](TransportWideCC.md#serialize) -- [deSerialize](TransportWideCC.md#deserialize) +# Class: TransportWideCC ## Constructors -### constructor +### new TransportWideCC() -• **new TransportWideCC**(`props?`): [`TransportWideCC`](TransportWideCC.md) +> **new TransportWideCC**(`props`): [`TransportWideCC`](TransportWideCC.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`TransportWideCC`](TransportWideCC.md)\> | +• **props**: `Partial`\<[`TransportWideCC`](TransportWideCC.md)\> = `{}` #### Returns @@ -52,81 +24,81 @@ ### baseSequenceNumber -• **baseSequenceNumber**: `number` +> **baseSequenceNumber**: `number` -___ +*** ### count -• **count**: `number` = `TransportWideCC.count` +> **count**: `number` = `TransportWideCC.count` -___ +*** ### fbPktCount -• **fbPktCount**: `number` +> **fbPktCount**: `number` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### length -• **length**: `number` = `2` +> **length**: `number` = `2` -___ +*** ### mediaSourceSsrc -• **mediaSourceSsrc**: `number` +> **mediaSourceSsrc**: `number` -___ +*** ### packetChunks -• **packetChunks**: ([`RunLengthChunk`](RunLengthChunk.md) \| [`StatusVectorChunk`](StatusVectorChunk.md))[] = `[]` +> **packetChunks**: ([`RunLengthChunk`](RunLengthChunk.md) \| [`StatusVectorChunk`](StatusVectorChunk.md))[] = `[]` -___ +*** ### packetStatusCount -• **packetStatusCount**: `number` +> **packetStatusCount**: `number` -___ +*** ### recvDeltas -• **recvDeltas**: [`RecvDelta`](RecvDelta.md)[] = `[]` +> **recvDeltas**: [`RecvDelta`](RecvDelta.md)[] = `[]` -___ +*** ### referenceTime -• **referenceTime**: `number` +> **referenceTime**: `number` 24bit multiples of 64ms -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `15` +> `static` **count**: `number` = `15` ## Accessors ### packetResults -• `get` **packetResults**(): [`PacketResult`](PacketResult.md)[] +> `get` **packetResults**(): [`PacketResult`](PacketResult.md)[] #### Returns @@ -134,26 +106,25 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`TransportWideCC`](TransportWideCC.md) +> `static` **deSerialize**(`data`, `header`): [`TransportWideCC`](TransportWideCC.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/doc/classes/TurnProtocol.md b/doc/classes/TurnProtocol.md new file mode 100644 index 000000000..f1a3fc134 --- /dev/null +++ b/doc/classes/TurnProtocol.md @@ -0,0 +1,293 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / TurnProtocol + +# Class: TurnProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new TurnProtocol() + +> **new TurnProtocol**(`server`, `username`, `password`, `lifetime`, `transport`, `options`): [`TurnProtocol`](TurnProtocol.md) + +#### Parameters + +• **server**: readonly [`string`, `number`] + +• **username**: `string` + +• **password**: `string` + +• **lifetime**: `number` + +• **transport**: [`Transport`](../interfaces/Transport.md) + +• **options** = `{}` + +• **options.channelRefreshTime?**: `number` + +sec + +#### Returns + +[`TurnProtocol`](TurnProtocol.md) + +## Properties + +### integrityKey? + +> `optional` **integrityKey**: `Buffer` + +*** + +### lifetime + +> **lifetime**: `number` + +*** + +### localCandidate + +> **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### mappedAddress + +> **mappedAddress**: readonly [`string`, `number`] + +*** + +### nonce? + +> `optional` **nonce**: `Buffer` + +*** + +### onData + +> `readonly` **onData**: [`Event`](Event.md)\<[`Buffer`, readonly [`string`, `number`]]\> + +*** + +### options + +> **options**: `object` = `{}` + +#### channelRefreshTime? + +> `optional` **channelRefreshTime**: `number` + +sec + +*** + +### password + +> **password**: `string` + +*** + +### realm? + +> `optional` **realm**: `string` + +*** + +### relayedAddress + +> **relayedAddress**: readonly [`string`, `number`] + +*** + +### server + +> **server**: readonly [`string`, `number`] + +*** + +### transactions + +> **transactions**: `object` = `{}` + +#### Index Signature + + \[`hexId`: `string`\]: `Transaction` + +*** + +### transport + +> **transport**: [`Transport`](../interfaces/Transport.md) + +*** + +### type + +> `readonly` **type**: `string` = `TurnProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### username + +> **username**: `string` + +*** + +### type + +> `static` **type**: `string` = `"turn"` + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionMade() + +> **connectionMade**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### getChannel() + +> **getChannel**(`addr`): `Promise`\<`object`\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`object`\> + +##### address + +> **address**: readonly [`string`, `number`] + +##### number + +> **number**: `number` + +*** + +### getPermission() + +> **getPermission**(`addr`): `Promise`\<`void`\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### request() + +> **request**(`request`, `addr`): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### requestWithRetry() + +> **requestWithRetry**(`request`, `addr`): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/doc/classes/UdpTransport.md b/doc/classes/UdpTransport.md new file mode 100644 index 000000000..557435b0f --- /dev/null +++ b/doc/classes/UdpTransport.md @@ -0,0 +1,109 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / UdpTransport + +# Class: UdpTransport + +## Implements + +- [`Transport`](../interfaces/Transport.md) + +## Properties + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`onData`](../interfaces/Transport.md#ondata) + +*** + +### socket + +> `readonly` **socket**: `Socket` + +*** + +### type + +> `readonly` **type**: `"udp"` = `"udp"` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`type`](../interfaces/Transport.md#type) + +## Methods + +### address() + +> **address**(): `AddressInfo` + +#### Returns + +`AddressInfo` + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`close`](../interfaces/Transport.md#close) + +*** + +### send() + +> **send**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`send`](../interfaces/Transport.md#send) + +*** + +### init() + +> `static` **init**(`type`, `portRange`?, `interfaceAddresses`?): `Promise`\<[`UdpTransport`](UdpTransport.md)\> + +#### Parameters + +• **type**: `SocketType` + +• **portRange?**: [`number`, `number`] + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +#### Returns + +`Promise`\<[`UdpTransport`](UdpTransport.md)\> diff --git a/doc/classes/Vp8RtpPayload.md b/doc/classes/Vp8RtpPayload.md index eb6718ded..4ca688688 100644 --- a/doc/classes/Vp8RtpPayload.md +++ b/doc/classes/Vp8RtpPayload.md @@ -1,4 +1,8 @@ -[werift](../README.md) / [Exports](../modules.md) / Vp8RtpPayload +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Vp8RtpPayload # Class: Vp8RtpPayload @@ -6,49 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](Vp8RtpPayload.md#constructor) - -### Properties - -- [hBit](Vp8RtpPayload.md#hbit) -- [iBit](Vp8RtpPayload.md#ibit) -- [kBit](Vp8RtpPayload.md#kbit) -- [lBit](Vp8RtpPayload.md#lbit) -- [mBit](Vp8RtpPayload.md#mbit) -- [nBit](Vp8RtpPayload.md#nbit) -- [pBit](Vp8RtpPayload.md#pbit) -- [payload](Vp8RtpPayload.md#payload) -- [pictureId](Vp8RtpPayload.md#pictureid) -- [pid](Vp8RtpPayload.md#pid) -- [sBit](Vp8RtpPayload.md#sbit) -- [size0](Vp8RtpPayload.md#size0) -- [size1](Vp8RtpPayload.md#size1) -- [size2](Vp8RtpPayload.md#size2) -- [tBit](Vp8RtpPayload.md#tbit) -- [ver](Vp8RtpPayload.md#ver) -- [xBit](Vp8RtpPayload.md#xbit) - -### Accessors - -- [isKeyframe](Vp8RtpPayload.md#iskeyframe) -- [isPartitionHead](Vp8RtpPayload.md#ispartitionhead) -- [payloadHeaderExist](Vp8RtpPayload.md#payloadheaderexist) -- [size](Vp8RtpPayload.md#size) - -### Methods - -- [deSerialize](Vp8RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](Vp8RtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new Vp8RtpPayload() -• **new Vp8RtpPayload**(): [`Vp8RtpPayload`](Vp8RtpPayload.md) +> **new Vp8RtpPayload**(): [`Vp8RtpPayload`](Vp8RtpPayload.md) #### Returns @@ -56,115 +22,115 @@ ## Properties -### hBit +### hBit? -• `Optional` **hBit**: `number` +> `optional` **hBit**: `number` -___ +*** -### iBit +### iBit? -• `Optional` **iBit**: `number` +> `optional` **iBit**: `number` -___ +*** -### kBit +### kBit? -• `Optional` **kBit**: `number` +> `optional` **kBit**: `number` -___ +*** -### lBit +### lBit? -• `Optional` **lBit**: `number` +> `optional` **lBit**: `number` -___ +*** -### mBit +### mBit? -• `Optional` **mBit**: `number` +> `optional` **mBit**: `number` -___ +*** ### nBit -• **nBit**: `number` +> **nBit**: `number` -___ +*** -### pBit +### pBit? -• `Optional` **pBit**: `number` +> `optional` **pBit**: `number` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** -### pictureId +### pictureId? -• `Optional` **pictureId**: `number` +> `optional` **pictureId**: `number` -___ +*** ### pid -• **pid**: `number` +> **pid**: `number` -___ +*** ### sBit -• **sBit**: `number` +> **sBit**: `number` -___ +*** ### size0 -• **size0**: `number` = `0` +> **size0**: `number` = `0` -___ +*** ### size1 -• **size1**: `number` = `0` +> **size1**: `number` = `0` -___ +*** ### size2 -• **size2**: `number` = `0` +> **size2**: `number` = `0` -___ +*** -### tBit +### tBit? -• `Optional` **tBit**: `number` +> `optional` **tBit**: `number` -___ +*** -### ver +### ver? -• `Optional` **ver**: `number` +> `optional` **ver**: `number` -___ +*** ### xBit -• **xBit**: `number` +> **xBit**: `number` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -172,33 +138,33 @@ ___ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` +> `get` **isPartitionHead**(): `boolean` #### Returns `boolean` -___ +*** ### payloadHeaderExist -• `get` **payloadHeaderExist**(): `boolean` +> `get` **payloadHeaderExist**(): `boolean` #### Returns `boolean` -___ +*** ### size -• `get` **size**(): `number` +> `get` **size**(): `number` #### Returns @@ -206,31 +172,27 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`Vp8RtpPayload`](Vp8RtpPayload.md) +> `static` **deSerialize**(`buf`): [`Vp8RtpPayload`](Vp8RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`Vp8RtpPayload`](Vp8RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/doc/classes/Vp9RtpPayload.md b/doc/classes/Vp9RtpPayload.md index 55fa795a3..726b07e53 100644 --- a/doc/classes/Vp9RtpPayload.md +++ b/doc/classes/Vp9RtpPayload.md @@ -1,4 +1,8 @@ -[werift](../README.md) / [Exports](../modules.md) / Vp9RtpPayload +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Vp9RtpPayload # Class: Vp9RtpPayload @@ -6,57 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](Vp9RtpPayload.md#constructor) - -### Properties - -- [bBit](Vp9RtpPayload.md#bbit) -- [d](Vp9RtpPayload.md#d) -- [eBit](Vp9RtpPayload.md#ebit) -- [fBit](Vp9RtpPayload.md#fbit) -- [g](Vp9RtpPayload.md#g) -- [height](Vp9RtpPayload.md#height) -- [iBit](Vp9RtpPayload.md#ibit) -- [lBit](Vp9RtpPayload.md#lbit) -- [m](Vp9RtpPayload.md#m) -- [n\_g](Vp9RtpPayload.md#n_g) -- [n\_s](Vp9RtpPayload.md#n_s) -- [pBit](Vp9RtpPayload.md#pbit) -- [pDiff](Vp9RtpPayload.md#pdiff) -- [payload](Vp9RtpPayload.md#payload) -- [pgP\_Diff](Vp9RtpPayload.md#pgp_diff) -- [pgT](Vp9RtpPayload.md#pgt) -- [pgU](Vp9RtpPayload.md#pgu) -- [pictureId](Vp9RtpPayload.md#pictureid) -- [sid](Vp9RtpPayload.md#sid) -- [tid](Vp9RtpPayload.md#tid) -- [tl0PicIdx](Vp9RtpPayload.md#tl0picidx) -- [u](Vp9RtpPayload.md#u) -- [vBit](Vp9RtpPayload.md#vbit) -- [width](Vp9RtpPayload.md#width) -- [y](Vp9RtpPayload.md#y) -- [zBit](Vp9RtpPayload.md#zbit) - -### Accessors - -- [isKeyframe](Vp9RtpPayload.md#iskeyframe) -- [isPartitionHead](Vp9RtpPayload.md#ispartitionhead) - -### Methods - -- [deSerialize](Vp9RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](Vp9RtpPayload.md#isdetectedfinalpacketinsequence) -- [parseRtpPayload](Vp9RtpPayload.md#parsertppayload) - ## Constructors -### constructor +### new Vp9RtpPayload() -• **new Vp9RtpPayload**(): [`Vp9RtpPayload`](Vp9RtpPayload.md) +> **new Vp9RtpPayload**(): [`Vp9RtpPayload`](Vp9RtpPayload.md) #### Returns @@ -66,183 +24,183 @@ ### bBit -• **bBit**: `number` +> **bBit**: `number` Start of a frame -___ +*** -### d +### d? -• `Optional` **d**: `number` +> `optional` **d**: `number` inter_layer_predicted -___ +*** ### eBit -• **eBit**: `number` +> **eBit**: `number` End of a frame -___ +*** ### fBit -• **fBit**: `number` +> **fBit**: `number` Flexible mode -___ +*** -### g +### g? -• `Optional` **g**: `number` +> `optional` **g**: `number` -___ +*** ### height -• **height**: `number`[] = `[]` +> **height**: `number`[] = `[]` -___ +*** ### iBit -• **iBit**: `number` +> **iBit**: `number` Picture ID (PID) present -___ +*** ### lBit -• **lBit**: `number` +> **lBit**: `number` Layer indices present -___ +*** -### m +### m? -• `Optional` **m**: `number` +> `optional` **m**: `number` -___ +*** ### n\_g -• **n\_g**: `number` = `0` +> **n\_g**: `number` = `0` -___ +*** -### n\_s +### n\_s? -• `Optional` **n\_s**: `number` +> `optional` **n\_s**: `number` -___ +*** ### pBit -• **pBit**: `number` +> **pBit**: `number` Inter-picture predicted frame -___ +*** ### pDiff -• **pDiff**: `number`[] = `[]` +> **pDiff**: `number`[] = `[]` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** ### pgP\_Diff -• **pgP\_Diff**: `number`[][] = `[]` +> **pgP\_Diff**: `number`[][] = `[]` -___ +*** ### pgT -• **pgT**: `number`[] = `[]` +> **pgT**: `number`[] = `[]` -___ +*** ### pgU -• **pgU**: `number`[] = `[]` +> **pgU**: `number`[] = `[]` -___ +*** -### pictureId +### pictureId? -• `Optional` **pictureId**: `number` +> `optional` **pictureId**: `number` -___ +*** -### sid +### sid? -• `Optional` **sid**: `number` +> `optional` **sid**: `number` -___ +*** -### tid +### tid? -• `Optional` **tid**: `number` +> `optional` **tid**: `number` -___ +*** -### tl0PicIdx +### tl0PicIdx? -• `Optional` **tl0PicIdx**: `number` +> `optional` **tl0PicIdx**: `number` -___ +*** -### u +### u? -• `Optional` **u**: `number` +> `optional` **u**: `number` -___ +*** ### vBit -• **vBit**: `number` +> **vBit**: `number` Scalability structure -___ +*** ### width -• **width**: `number`[] = `[]` +> **width**: `number`[] = `[]` -___ +*** -### y +### y? -• `Optional` **y**: `number` +> `optional` **y**: `number` -___ +*** ### zBit -• **zBit**: `number` +> **zBit**: `number` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -250,67 +208,64 @@ ___ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` \| ``0`` +> `get` **isPartitionHead**(): `boolean` \| `0` #### Returns -`boolean` \| ``0`` +`boolean` \| `0` ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`Vp9RtpPayload`](Vp9RtpPayload.md) +> `static` **deSerialize**(`buf`): [`Vp9RtpPayload`](Vp9RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`Vp9RtpPayload`](Vp9RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns `boolean` -___ +*** -### parseRtpPayload +### parseRtpPayload() -▸ **parseRtpPayload**(`buf`): `Object` +> `static` **parseRtpPayload**(`buf`): `object` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns -`Object` +`object` + +##### offset + +> **offset**: `number` + +##### p -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `p` | [`Vp9RtpPayload`](Vp9RtpPayload.md) | +> **p**: [`Vp9RtpPayload`](Vp9RtpPayload.md) diff --git a/doc/classes/WeriftError.md b/doc/classes/WeriftError.md index c09a3dcb5..524c82724 100644 --- a/doc/classes/WeriftError.md +++ b/doc/classes/WeriftError.md @@ -1,46 +1,24 @@ -[werift](../README.md) / [Exports](../modules.md) / WeriftError +[**werift**](../README.md) • **Docs** -# Class: WeriftError - -## Hierarchy - -- `Error` - - ↳ **`WeriftError`** - -## Table of contents +*** -### Constructors +[werift](../globals.md) / WeriftError -- [constructor](WeriftError.md#constructor) - -### Properties - -- [cause](WeriftError.md#cause) -- [message](WeriftError.md#message) -- [name](WeriftError.md#name) -- [path](WeriftError.md#path) -- [payload](WeriftError.md#payload) -- [stack](WeriftError.md#stack) -- [prepareStackTrace](WeriftError.md#preparestacktrace) -- [stackTraceLimit](WeriftError.md#stacktracelimit) +# Class: WeriftError -### Methods +## Extends -- [toJSON](WeriftError.md#tojson) -- [captureStackTrace](WeriftError.md#capturestacktrace) +- `Error` ## Constructors -### constructor +### new WeriftError() -• **new WeriftError**(`props`): [`WeriftError`](WeriftError.md) +> **new WeriftError**(`props`): [`WeriftError`](WeriftError.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Pick`\<[`WeriftError`](WeriftError.md), ``"message"`` \| ``"payload"`` \| ``"path"``\> | +• **props**: `Pick`\<[`WeriftError`](WeriftError.md), `"message"` \| `"payload"` \| `"path"`\> #### Returns @@ -48,137 +26,131 @@ #### Overrides -Error.constructor +`Error.constructor` ## Properties -### cause +### cause? -• `Optional` **cause**: `unknown` +> `optional` **cause**: `unknown` #### Inherited from -Error.cause +`Error.cause` -___ +*** ### message -• **message**: `string` +> **message**: `string` #### Overrides -Error.message +`Error.message` -___ +*** ### name -• **name**: `string` +> **name**: `string` #### Inherited from -Error.name +`Error.name` -___ +*** -### path +### path? -• `Optional` **path**: `string` +> `optional` **path**: `string` -___ +*** -### payload +### payload? -• `Optional` **payload**: `object` +> `optional` **payload**: `object` -___ +*** -### stack +### stack? -• `Optional` **stack**: `string` +> `optional` **stack**: `string` #### Inherited from -Error.stack +`Error.stack` -___ +*** -### prepareStackTrace +### prepareStackTrace()? -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` +> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` Optional override for formatting stack traces -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces +#### Parameters -##### Parameters +• **err**: `Error` -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | +• **stackTraces**: `CallSite`[] -##### Returns +#### Returns `any` -**`See`** +#### See https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -Error.prepareStackTrace +`Error.prepareStackTrace` -___ +*** ### stackTraceLimit -▪ `Static` **stackTraceLimit**: `number` +> `static` **stackTraceLimit**: `number` #### Inherited from -Error.stackTraceLimit +`Error.stackTraceLimit` ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `path` | `undefined` \| `string` | -| `payload` | `any` | +##### message -___ +> **message**: `string` -### captureStackTrace +##### path -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` +> **path**: `undefined` \| `string` + +##### payload + +> **payload**: `any` + +*** + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` Create .stack property on a target object #### Parameters -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | +• **targetObject**: `object` + +• **constructorOpt?**: `Function` #### Returns @@ -186,4 +158,4 @@ Create .stack property on a target object #### Inherited from -Error.captureStackTrace +`Error.captureStackTrace` diff --git a/doc/enumerations/CandidatePairState.md b/doc/enumerations/CandidatePairState.md new file mode 100644 index 000000000..2c71a88a3 --- /dev/null +++ b/doc/enumerations/CandidatePairState.md @@ -0,0 +1,37 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CandidatePairState + +# Enumeration: CandidatePairState + +## Enumeration Members + +### FAILED + +> **FAILED**: `4` + +*** + +### FROZEN + +> **FROZEN**: `0` + +*** + +### IN\_PROGRESS + +> **IN\_PROGRESS**: `2` + +*** + +### SUCCEEDED + +> **SUCCEEDED**: `3` + +*** + +### WAITING + +> **WAITING**: `1` diff --git a/doc/enumerations/PacketChunk.md b/doc/enumerations/PacketChunk.md new file mode 100644 index 000000000..ff2859e7a --- /dev/null +++ b/doc/enumerations/PacketChunk.md @@ -0,0 +1,25 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / PacketChunk + +# Enumeration: PacketChunk + +## Enumeration Members + +### TypeTCCRunLengthChunk + +> **TypeTCCRunLengthChunk**: `0` + +*** + +### TypeTCCStatusVectorChunk + +> **TypeTCCStatusVectorChunk**: `1` + +*** + +### packetStatusChunkLength + +> **packetStatusChunkLength**: `2` diff --git a/doc/enumerations/PacketStatus.md b/doc/enumerations/PacketStatus.md new file mode 100644 index 000000000..4067592f7 --- /dev/null +++ b/doc/enumerations/PacketStatus.md @@ -0,0 +1,31 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / PacketStatus + +# Enumeration: PacketStatus + +## Enumeration Members + +### TypeTCCPacketNotReceived + +> **TypeTCCPacketNotReceived**: `0` + +*** + +### TypeTCCPacketReceivedLargeDelta + +> **TypeTCCPacketReceivedLargeDelta**: `2` + +*** + +### TypeTCCPacketReceivedSmallDelta + +> **TypeTCCPacketReceivedSmallDelta**: `1` + +*** + +### TypeTCCPacketReceivedWithoutDelta + +> **TypeTCCPacketReceivedWithoutDelta**: `3` diff --git a/doc/enumerations/classes.md b/doc/enumerations/classes.md new file mode 100644 index 000000000..c0ce706ae --- /dev/null +++ b/doc/enumerations/classes.md @@ -0,0 +1,31 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / classes + +# Enumeration: classes + +## Enumeration Members + +### ERROR + +> **ERROR**: `272` + +*** + +### INDICATION + +> **INDICATION**: `16` + +*** + +### REQUEST + +> **REQUEST**: `0` + +*** + +### RESPONSE + +> **RESPONSE**: `256` diff --git a/doc/enumerations/methods.md b/doc/enumerations/methods.md new file mode 100644 index 000000000..bf4afcc74 --- /dev/null +++ b/doc/enumerations/methods.md @@ -0,0 +1,55 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / methods + +# Enumeration: methods + +## Enumeration Members + +### ALLOCATE + +> **ALLOCATE**: `3` + +*** + +### BINDING + +> **BINDING**: `1` + +*** + +### CHANNEL\_BIND + +> **CHANNEL\_BIND**: `9` + +*** + +### CREATE\_PERMISSION + +> **CREATE\_PERMISSION**: `8` + +*** + +### DATA + +> **DATA**: `7` + +*** + +### REFRESH + +> **REFRESH**: `4` + +*** + +### SEND + +> **SEND**: `6` + +*** + +### SHARED\_SECRET + +> **SHARED\_SECRET**: `2` diff --git a/doc/enums/CandidatePairState.md b/doc/enums/CandidatePairState.md deleted file mode 100644 index 948a5d285..000000000 --- a/doc/enums/CandidatePairState.md +++ /dev/null @@ -1,43 +0,0 @@ -[werift](../README.md) / [Exports](../modules.md) / CandidatePairState - -# Enumeration: CandidatePairState - -## Table of contents - -### Enumeration Members - -- [FAILED](CandidatePairState.md#failed) -- [FROZEN](CandidatePairState.md#frozen) -- [IN\_PROGRESS](CandidatePairState.md#in_progress) -- [SUCCEEDED](CandidatePairState.md#succeeded) -- [WAITING](CandidatePairState.md#waiting) - -## Enumeration Members - -### FAILED - -• **FAILED** = ``4`` - -___ - -### FROZEN - -• **FROZEN** = ``0`` - -___ - -### IN\_PROGRESS - -• **IN\_PROGRESS** = ``2`` - -___ - -### SUCCEEDED - -• **SUCCEEDED** = ``3`` - -___ - -### WAITING - -• **WAITING** = ``1`` diff --git a/doc/enums/PacketChunk.md b/doc/enums/PacketChunk.md deleted file mode 100644 index df73c6be4..000000000 --- a/doc/enums/PacketChunk.md +++ /dev/null @@ -1,29 +0,0 @@ -[werift](../README.md) / [Exports](../modules.md) / PacketChunk - -# Enumeration: PacketChunk - -## Table of contents - -### Enumeration Members - -- [TypeTCCRunLengthChunk](PacketChunk.md#typetccrunlengthchunk) -- [TypeTCCStatusVectorChunk](PacketChunk.md#typetccstatusvectorchunk) -- [packetStatusChunkLength](PacketChunk.md#packetstatuschunklength) - -## Enumeration Members - -### TypeTCCRunLengthChunk - -• **TypeTCCRunLengthChunk** = ``0`` - -___ - -### TypeTCCStatusVectorChunk - -• **TypeTCCStatusVectorChunk** = ``1`` - -___ - -### packetStatusChunkLength - -• **packetStatusChunkLength** = ``2`` diff --git a/doc/enums/PacketStatus.md b/doc/enums/PacketStatus.md deleted file mode 100644 index e7faa616e..000000000 --- a/doc/enums/PacketStatus.md +++ /dev/null @@ -1,36 +0,0 @@ -[werift](../README.md) / [Exports](../modules.md) / PacketStatus - -# Enumeration: PacketStatus - -## Table of contents - -### Enumeration Members - -- [TypeTCCPacketNotReceived](PacketStatus.md#typetccpacketnotreceived) -- [TypeTCCPacketReceivedLargeDelta](PacketStatus.md#typetccpacketreceivedlargedelta) -- [TypeTCCPacketReceivedSmallDelta](PacketStatus.md#typetccpacketreceivedsmalldelta) -- [TypeTCCPacketReceivedWithoutDelta](PacketStatus.md#typetccpacketreceivedwithoutdelta) - -## Enumeration Members - -### TypeTCCPacketNotReceived - -• **TypeTCCPacketNotReceived** = ``0`` - -___ - -### TypeTCCPacketReceivedLargeDelta - -• **TypeTCCPacketReceivedLargeDelta** = ``2`` - -___ - -### TypeTCCPacketReceivedSmallDelta - -• **TypeTCCPacketReceivedSmallDelta** = ``1`` - -___ - -### TypeTCCPacketReceivedWithoutDelta - -• **TypeTCCPacketReceivedWithoutDelta** = ``3`` diff --git a/doc/functions/Int.md b/doc/functions/Int.md new file mode 100644 index 000000000..326656686 --- /dev/null +++ b/doc/functions/Int.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Int + +# Function: Int() + +> **Int**(`v`): `number` + +## Parameters + +• **v**: `number` + +## Returns + +`number` diff --git a/doc/functions/addSDPHeader.md b/doc/functions/addSDPHeader.md new file mode 100644 index 000000000..a9a4a1294 --- /dev/null +++ b/doc/functions/addSDPHeader.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / addSDPHeader + +# Function: addSDPHeader() + +> **addSDPHeader**(`type`, `description`): `void` + +## Parameters + +• **type**: `"offer"` \| `"answer"` + +• **description**: [`SessionDescription`](../classes/SessionDescription.md) + +## Returns + +`void` diff --git a/doc/functions/addTransportDescription.md b/doc/functions/addTransportDescription.md new file mode 100644 index 000000000..43af4b169 --- /dev/null +++ b/doc/functions/addTransportDescription.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / addTransportDescription + +# Function: addTransportDescription() + +> **addTransportDescription**(`media`, `dtlsTransport`): `void` + +## Parameters + +• **media**: [`MediaDescription`](../classes/MediaDescription.md) + +• **dtlsTransport**: [`RTCDtlsTransport`](../classes/RTCDtlsTransport.md) + +## Returns + +`void` diff --git a/doc/functions/allocateMid.md b/doc/functions/allocateMid.md new file mode 100644 index 000000000..c6e56bc2f --- /dev/null +++ b/doc/functions/allocateMid.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / allocateMid + +# Function: allocateMid() + +> **allocateMid**(`mids`, `type`): `string` + +## Parameters + +• **mids**: `Set`\<`string`\> + +• **type**: `""` \| `"dc"` \| `"av"` + +## Returns + +`string` diff --git a/doc/functions/andDirection.md b/doc/functions/andDirection.md new file mode 100644 index 000000000..dc18840fc --- /dev/null +++ b/doc/functions/andDirection.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / andDirection + +# Function: andDirection() + +> **andDirection**(`a`, `b`): `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` + +## Parameters + +• **a**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` + +• **b**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` + +## Returns + +`"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` diff --git a/doc/functions/buffer2ArrayBuffer.md b/doc/functions/buffer2ArrayBuffer.md new file mode 100644 index 000000000..cf2cef6c2 --- /dev/null +++ b/doc/functions/buffer2ArrayBuffer.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / buffer2ArrayBuffer + +# Function: buffer2ArrayBuffer() + +> **buffer2ArrayBuffer**(`buf`): `ArrayBuffer` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`ArrayBuffer` diff --git a/doc/functions/bufferArrayXor.md b/doc/functions/bufferArrayXor.md new file mode 100644 index 000000000..20a284709 --- /dev/null +++ b/doc/functions/bufferArrayXor.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / bufferArrayXor + +# Function: bufferArrayXor() + +> **bufferArrayXor**(`arr`): `Buffer` + +## Parameters + +• **arr**: `Buffer`[] + +## Returns + +`Buffer` diff --git a/doc/functions/bufferReader.md b/doc/functions/bufferReader.md new file mode 100644 index 000000000..05d3692ad --- /dev/null +++ b/doc/functions/bufferReader.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / bufferReader + +# Function: bufferReader() + +> **bufferReader**(`buf`, `bytes`): `any`[] + +## Parameters + +• **buf**: `Buffer` + +• **bytes**: `number`[] + +## Returns + +`any`[] diff --git a/doc/functions/bufferWriter.md b/doc/functions/bufferWriter.md new file mode 100644 index 000000000..18d19949f --- /dev/null +++ b/doc/functions/bufferWriter.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / bufferWriter + +# Function: bufferWriter() + +> **bufferWriter**(`bytes`, `values`): `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **values**: (`number` \| `bigint`)[] + +## Returns + +`Buffer` diff --git a/doc/functions/bufferWriterLE.md b/doc/functions/bufferWriterLE.md new file mode 100644 index 000000000..3c1c7e4dc --- /dev/null +++ b/doc/functions/bufferWriterLE.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / bufferWriterLE + +# Function: bufferWriterLE() + +> **bufferWriterLE**(`bytes`, `values`): `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **values**: (`number` \| `bigint`)[] + +## Returns + +`Buffer` diff --git a/doc/functions/bufferXor.md b/doc/functions/bufferXor.md new file mode 100644 index 000000000..c83a76821 --- /dev/null +++ b/doc/functions/bufferXor.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / bufferXor + +# Function: bufferXor() + +> **bufferXor**(`a`, `b`): `Buffer` + +## Parameters + +• **a**: `Buffer` + +• **b**: `Buffer` + +## Returns + +`Buffer` diff --git a/doc/functions/candidateFoundation.md b/doc/functions/candidateFoundation.md new file mode 100644 index 000000000..321164e33 --- /dev/null +++ b/doc/functions/candidateFoundation.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidateFoundation + +# Function: candidateFoundation() + +> **candidateFoundation**(`candidateType`, `candidateTransport`, `baseAddress`): `string` + +## Parameters + +• **candidateType**: `string` + +• **candidateTransport**: `string` + +• **baseAddress**: `string` + +## Returns + +`string` diff --git a/doc/functions/candidateFromIce.md b/doc/functions/candidateFromIce.md new file mode 100644 index 000000000..329f909ab --- /dev/null +++ b/doc/functions/candidateFromIce.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidateFromIce + +# Function: candidateFromIce() + +> **candidateFromIce**(`c`): [`IceCandidate`](../classes/IceCandidate.md) + +## Parameters + +• **c**: [`Candidate`](../classes/Candidate.md) + +## Returns + +[`IceCandidate`](../classes/IceCandidate.md) diff --git a/doc/functions/candidateFromSdp.md b/doc/functions/candidateFromSdp.md new file mode 100644 index 000000000..ef5f669cc --- /dev/null +++ b/doc/functions/candidateFromSdp.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidateFromSdp + +# Function: candidateFromSdp() + +> **candidateFromSdp**(`sdp`): [`IceCandidate`](../classes/IceCandidate.md) + +## Parameters + +• **sdp**: `string` + +## Returns + +[`IceCandidate`](../classes/IceCandidate.md) diff --git a/doc/functions/candidatePairPriority.md b/doc/functions/candidatePairPriority.md new file mode 100644 index 000000000..a64e04ae1 --- /dev/null +++ b/doc/functions/candidatePairPriority.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidatePairPriority + +# Function: candidatePairPriority() + +> **candidatePairPriority**(`local`, `remote`, `iceControlling`): `number` + +## Parameters + +• **local**: `Pick`\<[`Candidate`](../classes/Candidate.md), `"priority"`\> + +• **remote**: `Pick`\<[`Candidate`](../classes/Candidate.md), `"priority"`\> + +• **iceControlling**: `boolean` + +## Returns + +`number` diff --git a/doc/functions/candidatePriority.md b/doc/functions/candidatePriority.md new file mode 100644 index 000000000..a13dd9dba --- /dev/null +++ b/doc/functions/candidatePriority.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidatePriority + +# Function: candidatePriority() + +> **candidatePriority**(`candidateType`, `localPref`): `number` + +## Parameters + +• **candidateType**: `string` + +• **localPref**: `number` = `65535` + +## Returns + +`number` diff --git a/doc/functions/candidateToIce.md b/doc/functions/candidateToIce.md new file mode 100644 index 000000000..b9d3561d4 --- /dev/null +++ b/doc/functions/candidateToIce.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidateToIce + +# Function: candidateToIce() + +> **candidateToIce**(`x`): [`Candidate`](../classes/Candidate.md) + +## Parameters + +• **x**: [`IceCandidate`](../classes/IceCandidate.md) + +## Returns + +[`Candidate`](../classes/Candidate.md) diff --git a/doc/functions/candidateToSdp.md b/doc/functions/candidateToSdp.md new file mode 100644 index 000000000..c963c5b5b --- /dev/null +++ b/doc/functions/candidateToSdp.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / candidateToSdp + +# Function: candidateToSdp() + +> **candidateToSdp**(`c`): `string` + +## Parameters + +• **c**: [`IceCandidate`](../classes/IceCandidate.md) + +## Returns + +`string` diff --git a/doc/functions/codecParametersFromString.md b/doc/functions/codecParametersFromString.md new file mode 100644 index 000000000..6a3b78947 --- /dev/null +++ b/doc/functions/codecParametersFromString.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / codecParametersFromString + +# Function: codecParametersFromString() + +> **codecParametersFromString**(`str`): `any` + +## Parameters + +• **str**: `string` + +## Returns + +`any` diff --git a/doc/functions/codecParametersToString.md b/doc/functions/codecParametersToString.md new file mode 100644 index 000000000..0514ad6a5 --- /dev/null +++ b/doc/functions/codecParametersToString.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / codecParametersToString + +# Function: codecParametersToString() + +> **codecParametersToString**(`parameters`, `joint`): `undefined` \| `string` + +## Parameters + +• **parameters** + +• **joint**: `string` = `"="` + +## Returns + +`undefined` \| `string` diff --git a/doc/functions/compactNtp.md b/doc/functions/compactNtp.md new file mode 100644 index 000000000..ee3ecdb03 --- /dev/null +++ b/doc/functions/compactNtp.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / compactNtp + +# Function: compactNtp() + +> **compactNtp**(`ntp`): `number` + +https://datatracker.ietf.org/doc/html/rfc3550#section-4 + +## Parameters + +• **ntp**: `bigint` + +## Returns + +`number` + +32bit diff --git a/doc/functions/createBufferWriter.md b/doc/functions/createBufferWriter.md new file mode 100644 index 000000000..cc5ab7268 --- /dev/null +++ b/doc/functions/createBufferWriter.md @@ -0,0 +1,27 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createBufferWriter + +# Function: createBufferWriter() + +> **createBufferWriter**(`bytes`, `singleBuffer`?): (`values`) => `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **singleBuffer?**: `boolean` + +## Returns + +`Function` + +### Parameters + +• **values**: (`number` \| `bigint`)[] + +### Returns + +`Buffer` diff --git a/doc/functions/createMediaDescriptionForSctp.md b/doc/functions/createMediaDescriptionForSctp.md new file mode 100644 index 000000000..21ae9dd0f --- /dev/null +++ b/doc/functions/createMediaDescriptionForSctp.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createMediaDescriptionForSctp + +# Function: createMediaDescriptionForSctp() + +> **createMediaDescriptionForSctp**(`sctp`): [`MediaDescription`](../classes/MediaDescription.md) + +## Parameters + +• **sctp**: [`RTCSctpTransport`](../classes/RTCSctpTransport.md) + +## Returns + +[`MediaDescription`](../classes/MediaDescription.md) diff --git a/doc/functions/createMediaDescriptionForTransceiver.md b/doc/functions/createMediaDescriptionForTransceiver.md new file mode 100644 index 000000000..35d25b757 --- /dev/null +++ b/doc/functions/createMediaDescriptionForTransceiver.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createMediaDescriptionForTransceiver + +# Function: createMediaDescriptionForTransceiver() + +> **createMediaDescriptionForTransceiver**(`transceiver`, `cname`, `direction`): [`MediaDescription`](../classes/MediaDescription.md) + +## Parameters + +• **transceiver**: [`RTCRtpTransceiver`](../classes/RTCRtpTransceiver.md) + +• **cname**: `string` + +• **direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` + +## Returns + +[`MediaDescription`](../classes/MediaDescription.md) diff --git a/doc/functions/createSelfSignedCertificate.md b/doc/functions/createSelfSignedCertificate.md new file mode 100644 index 000000000..13de55cfe --- /dev/null +++ b/doc/functions/createSelfSignedCertificate.md @@ -0,0 +1,39 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createSelfSignedCertificate + +# Function: createSelfSignedCertificate() + +> **createSelfSignedCertificate**(`signatureHash`, `namedCurveAlgorithm`?): `Promise`\<`object`\> + +## Parameters + +• **signatureHash**: [`SignatureHash`](../type-aliases/SignatureHash.md) + +• **namedCurveAlgorithm?**: [`NamedCurveAlgorithms`](../type-aliases/NamedCurveAlgorithms.md) + +necessary when use ecdsa + +## Returns + +`Promise`\<`object`\> + +### certPem + +> **certPem**: `string` + +### keyPem + +> **keyPem**: `string` + +### signatureHash + +> **signatureHash**: [`SignatureHash`](../type-aliases/SignatureHash.md) + +## Param + +## Param + +necessary when use ecdsa diff --git a/doc/functions/createStunOverTurnClient.md b/doc/functions/createStunOverTurnClient.md new file mode 100644 index 000000000..c66944fdc --- /dev/null +++ b/doc/functions/createStunOverTurnClient.md @@ -0,0 +1,37 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createStunOverTurnClient + +# Function: createStunOverTurnClient() + +> **createStunOverTurnClient**(`__namedParameters`, `__namedParameters`): `Promise`\<[`StunOverTurnProtocol`](../classes/StunOverTurnProtocol.md)\> + +## Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.address**: readonly [`string`, `number`] + +• **\_\_namedParameters.ice**: [`Connection`](../classes/Connection.md) + +• **\_\_namedParameters.password**: `string` + +• **\_\_namedParameters.username**: `string` + +• **\_\_namedParameters** = `{}` + +• **\_\_namedParameters.interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +• **\_\_namedParameters.lifetime?**: `number` + +• **\_\_namedParameters.portRange?**: [`number`, `number`] + +• **\_\_namedParameters.ssl?**: `boolean` + +• **\_\_namedParameters.transport?**: `"tcp"` \| `"udp"` + +## Returns + +`Promise`\<[`StunOverTurnProtocol`](../classes/StunOverTurnProtocol.md)\> diff --git a/doc/functions/createTurnClient.md b/doc/functions/createTurnClient.md new file mode 100644 index 000000000..969d34670 --- /dev/null +++ b/doc/functions/createTurnClient.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / createTurnClient + +# Function: createTurnClient() + +> **createTurnClient**(`__namedParameters`, `__namedParameters`): `Promise`\<[`TurnProtocol`](../classes/TurnProtocol.md)\> + +## Parameters + +• **\_\_namedParameters**: [`TurnClientConfig`](../interfaces/TurnClientConfig.md) + +• **\_\_namedParameters**: [`TurnClientOptions`](../interfaces/TurnClientOptions.md) = `{}` + +## Returns + +`Promise`\<[`TurnProtocol`](../classes/TurnProtocol.md)\> diff --git a/doc/functions/dePacketizeRtpPackets.md b/doc/functions/dePacketizeRtpPackets.md new file mode 100644 index 000000000..73a56b76c --- /dev/null +++ b/doc/functions/dePacketizeRtpPackets.md @@ -0,0 +1,41 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / dePacketizeRtpPackets + +# Function: dePacketizeRtpPackets() + +> **dePacketizeRtpPackets**(`codec`, `packets`, `frameFragmentBuffer`?): `object` + +## Parameters + +• **codec**: [`DepacketizerCodec`](../type-aliases/DepacketizerCodec.md) + +• **packets**: [`RtpPacket`](../classes/RtpPacket.md)[] + +• **frameFragmentBuffer?**: `Buffer` + +## Returns + +`object` + +### data + +> **data**: `Buffer` + +### frameFragmentBuffer? + +> `optional` **frameFragmentBuffer**: `Buffer` + +### isKeyframe + +> **isKeyframe**: `boolean` + +### sequence + +> **sequence**: `number` + +### timestamp + +> **timestamp**: `number` diff --git a/doc/functions/deepMerge.md b/doc/functions/deepMerge.md new file mode 100644 index 000000000..ca25060dd --- /dev/null +++ b/doc/functions/deepMerge.md @@ -0,0 +1,23 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / deepMerge + +# Function: deepMerge() + +> **deepMerge**\<`T`\>(`dst`, `src`): `T` + +## Type Parameters + +• **T** + +## Parameters + +• **dst**: `T` + +• **src**: `T` + +## Returns + +`T` diff --git a/doc/functions/deserializeAbsSendTime.md b/doc/functions/deserializeAbsSendTime.md new file mode 100644 index 000000000..2e5ec08cd --- /dev/null +++ b/doc/functions/deserializeAbsSendTime.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / deserializeAbsSendTime + +# Function: deserializeAbsSendTime() + +> **deserializeAbsSendTime**(`buf`): `any` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`any` diff --git a/doc/functions/deserializeAudioLevelIndication.md b/doc/functions/deserializeAudioLevelIndication.md new file mode 100644 index 000000000..f63c803fe --- /dev/null +++ b/doc/functions/deserializeAudioLevelIndication.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / deserializeAudioLevelIndication + +# Function: deserializeAudioLevelIndication() + +> **deserializeAudioLevelIndication**(`buf`): [`AudioLevelIndicationPayload`](../type-aliases/AudioLevelIndicationPayload.md) + +## Parameters + +• **buf**: `Buffer` + +## Returns + +[`AudioLevelIndicationPayload`](../type-aliases/AudioLevelIndicationPayload.md) diff --git a/doc/functions/deserializeString.md b/doc/functions/deserializeString.md new file mode 100644 index 000000000..1c0151166 --- /dev/null +++ b/doc/functions/deserializeString.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / deserializeString + +# Function: deserializeString() + +> **deserializeString**(`buf`): `string` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`string` diff --git a/doc/functions/deserializeUint16BE.md b/doc/functions/deserializeUint16BE.md new file mode 100644 index 000000000..96221c926 --- /dev/null +++ b/doc/functions/deserializeUint16BE.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / deserializeUint16BE + +# Function: deserializeUint16BE() + +> **deserializeUint16BE**(`buf`): `number` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`number` diff --git a/doc/functions/dumpBuffer.md b/doc/functions/dumpBuffer.md new file mode 100644 index 000000000..9f9867d4b --- /dev/null +++ b/doc/functions/dumpBuffer.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / dumpBuffer + +# Function: dumpBuffer() + +> **dumpBuffer**(`data`): `string` + +## Parameters + +• **data**: `Buffer` + +## Returns + +`string` diff --git a/doc/functions/enumerate.md b/doc/functions/enumerate.md new file mode 100644 index 000000000..d0c3adc2a --- /dev/null +++ b/doc/functions/enumerate.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / enumerate + +# Function: enumerate() + +> **enumerate**\<`T`\>(`arr`): [`number`, `T`][] + +## Type Parameters + +• **T** + +## Parameters + +• **arr**: `T`[] + +## Returns + +[`number`, `T`][] diff --git a/doc/functions/findCodecByMimeType.md b/doc/functions/findCodecByMimeType.md new file mode 100644 index 000000000..5dc998a7f --- /dev/null +++ b/doc/functions/findCodecByMimeType.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / findCodecByMimeType + +# Function: findCodecByMimeType() + +> **findCodecByMimeType**(`codecs`, `target`): `undefined` \| [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md) + +## Parameters + +• **codecs**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] + +• **target**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md) + +## Returns + +`undefined` \| [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md) diff --git a/doc/functions/findPort.md b/doc/functions/findPort.md new file mode 100644 index 000000000..5a2c13ae9 --- /dev/null +++ b/doc/functions/findPort.md @@ -0,0 +1,23 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / findPort + +# Function: findPort() + +> **findPort**(`min`, `max`, `protocol`, `interfaceAddresses`?): `Promise`\<`number`\> + +## Parameters + +• **min**: `number` + +• **max**: `number` + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`\> diff --git a/doc/functions/fingerprint.md b/doc/functions/fingerprint.md new file mode 100644 index 000000000..ab9894f39 --- /dev/null +++ b/doc/functions/fingerprint.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / fingerprint + +# Function: fingerprint() + +> **fingerprint**(`file`, `hashName`): `any` + +## Parameters + +• **file**: `Buffer` + +• **hashName**: `string` + +## Returns + +`any` diff --git a/doc/functions/getBit.md b/doc/functions/getBit.md new file mode 100644 index 000000000..8582380ff --- /dev/null +++ b/doc/functions/getBit.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / getBit + +# Function: getBit() + +> **getBit**(`bits`, `startIndex`, `length`): `number` + +## Parameters + +• **bits**: `number` + +• **startIndex**: `number` + +• **length**: `number` = `1` + +## Returns + +`number` diff --git a/doc/functions/getGlobalIp.md b/doc/functions/getGlobalIp.md new file mode 100644 index 000000000..44b29b2b5 --- /dev/null +++ b/doc/functions/getGlobalIp.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / getGlobalIp + +# Function: getGlobalIp() + +> **getGlobalIp**(`stunServer`?, `interfaceAddresses`?): `Promise`\<`string`\> + +## Parameters + +• **stunServer?**: readonly [`string`, `number`] + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`string`\> diff --git a/doc/functions/getHostAddresses.md b/doc/functions/getHostAddresses.md new file mode 100644 index 000000000..8cef0363a --- /dev/null +++ b/doc/functions/getHostAddresses.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / getHostAddresses + +# Function: getHostAddresses() + +> **getHostAddresses**(`useIpv4`, `useIpv6`): `string`[] + +## Parameters + +• **useIpv4**: `boolean` + +• **useIpv6**: `boolean` + +## Returns + +`string`[] diff --git a/doc/functions/growBufferSize.md b/doc/functions/growBufferSize.md new file mode 100644 index 000000000..f2a02a912 --- /dev/null +++ b/doc/functions/growBufferSize.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / growBufferSize + +# Function: growBufferSize() + +> **growBufferSize**(`buf`, `size`): `Buffer` + +## Parameters + +• **buf**: `Buffer` + +• **size**: `number` + +## Returns + +`Buffer` diff --git a/doc/functions/int-1.md b/doc/functions/int-1.md new file mode 100644 index 000000000..bc7a081d3 --- /dev/null +++ b/doc/functions/int-1.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / int + +# Function: int() + +> **int**(`n`): `number` + +## Parameters + +• **n**: `number` + +## Returns + +`number` diff --git a/doc/functions/interfaceAddress.md b/doc/functions/interfaceAddress.md new file mode 100644 index 000000000..d69d42b2b --- /dev/null +++ b/doc/functions/interfaceAddress.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / interfaceAddress + +# Function: interfaceAddress() + +> **interfaceAddress**(`type`, `interfaceAddresses`): `undefined` \| `string` + +## Parameters + +• **type**: `SocketType` + +• **interfaceAddresses**: `undefined` \| [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`undefined` \| `string` diff --git a/doc/functions/isDtls.md b/doc/functions/isDtls.md new file mode 100644 index 000000000..c92c6a9de --- /dev/null +++ b/doc/functions/isDtls.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / isDtls + +# Function: isDtls() + +> **isDtls**(`buf`): `boolean` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`boolean` diff --git a/doc/functions/isMedia.md b/doc/functions/isMedia.md new file mode 100644 index 000000000..4a15749a0 --- /dev/null +++ b/doc/functions/isMedia.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / isMedia + +# Function: isMedia() + +> **isMedia**(`buf`): `boolean` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`boolean` diff --git a/doc/functions/isRtcp.md b/doc/functions/isRtcp.md new file mode 100644 index 000000000..b6163f42e --- /dev/null +++ b/doc/functions/isRtcp.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / isRtcp + +# Function: isRtcp() + +> **isRtcp**(`buf`): `boolean` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`boolean` diff --git a/doc/functions/leb128decode.md b/doc/functions/leb128decode.md new file mode 100644 index 000000000..48729ff60 --- /dev/null +++ b/doc/functions/leb128decode.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / leb128decode + +# Function: leb128decode() + +> **leb128decode**(`buf`): `number`[] + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`number`[] diff --git a/doc/functions/makeIntegrityKey.md b/doc/functions/makeIntegrityKey.md new file mode 100644 index 000000000..cdb49127e --- /dev/null +++ b/doc/functions/makeIntegrityKey.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / makeIntegrityKey + +# Function: makeIntegrityKey() + +> **makeIntegrityKey**(`username`, `realm`, `password`): `Buffer` + +## Parameters + +• **username**: `string` + +• **realm**: `string` + +• **password**: `string` + +## Returns + +`Buffer` diff --git a/doc/functions/microTime.md b/doc/functions/microTime.md new file mode 100644 index 000000000..80678ddee --- /dev/null +++ b/doc/functions/microTime.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / microTime + +# Function: microTime() + +> **microTime**(): `number` + +## Returns + +`number` diff --git a/doc/functions/milliTime.md b/doc/functions/milliTime.md new file mode 100644 index 000000000..cd1053354 --- /dev/null +++ b/doc/functions/milliTime.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / milliTime + +# Function: milliTime() + +> **milliTime**(): `number` + +## Returns + +`number` diff --git a/doc/functions/normalizeFamilyNodeV18.md b/doc/functions/normalizeFamilyNodeV18.md new file mode 100644 index 000000000..67c81333b --- /dev/null +++ b/doc/functions/normalizeFamilyNodeV18.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / normalizeFamilyNodeV18 + +# Function: normalizeFamilyNodeV18() + +> **normalizeFamilyNodeV18**(`family`): `4` \| `6` + +## Parameters + +• **family**: `string` \| `number` + +## Returns + +`4` \| `6` diff --git a/doc/functions/ntpTime.md b/doc/functions/ntpTime.md new file mode 100644 index 000000000..a40a8e23d --- /dev/null +++ b/doc/functions/ntpTime.md @@ -0,0 +1,15 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / ntpTime + +# Function: ntpTime() + +> **ntpTime**(): `bigint` + +https://datatracker.ietf.org/doc/html/rfc3550#section-4 + +## Returns + +`bigint` diff --git a/doc/functions/ntpTime2Sec.md b/doc/functions/ntpTime2Sec.md new file mode 100644 index 000000000..e0ddf707b --- /dev/null +++ b/doc/functions/ntpTime2Sec.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / ntpTime2Sec + +# Function: ntpTime2Sec() + +> **ntpTime2Sec**(`ntp`): `number` + +## Parameters + +• **ntp**: `bigint` + +## Returns + +`number` diff --git a/doc/functions/paddingBits.md b/doc/functions/paddingBits.md new file mode 100644 index 000000000..6121b1276 --- /dev/null +++ b/doc/functions/paddingBits.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / paddingBits + +# Function: paddingBits() + +> **paddingBits**(`bits`, `expectLength`): `string` + +## Parameters + +• **bits**: `number` + +• **expectLength**: `number` + +## Returns + +`string` diff --git a/doc/functions/paddingByte.md b/doc/functions/paddingByte.md new file mode 100644 index 000000000..31c68fecf --- /dev/null +++ b/doc/functions/paddingByte.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / paddingByte + +# Function: paddingByte() + +> **paddingByte**(`bits`): `string` + +## Parameters + +• **bits**: `number` + +## Returns + +`string` diff --git a/doc/functions/paddingLength.md b/doc/functions/paddingLength.md new file mode 100644 index 000000000..018cfecce --- /dev/null +++ b/doc/functions/paddingLength.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / paddingLength + +# Function: paddingLength() + +> **paddingLength**(`length`): `number` + +## Parameters + +• **length**: `number` + +## Returns + +`number` diff --git a/doc/functions/parseGroup.md b/doc/functions/parseGroup.md new file mode 100644 index 000000000..ae0e842e3 --- /dev/null +++ b/doc/functions/parseGroup.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / parseGroup + +# Function: parseGroup() + +> **parseGroup**(`dest`, `value`, `type`): `void` + +## Parameters + +• **dest**: [`GroupDescription`](../classes/GroupDescription.md)[] + +• **value**: `string` + +• **type** = `...` + +## Returns + +`void` diff --git a/doc/functions/parseIceServers.md b/doc/functions/parseIceServers.md new file mode 100644 index 000000000..57c71b653 --- /dev/null +++ b/doc/functions/parseIceServers.md @@ -0,0 +1,33 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / parseIceServers + +# Function: parseIceServers() + +> **parseIceServers**(`iceServers`): `object` + +## Parameters + +• **iceServers**: [`RTCIceServer`](../type-aliases/RTCIceServer.md)[] + +## Returns + +`object` + +### stunServer + +> **stunServer**: `undefined` \| readonly [`string`, `number`] + +### turnPassword + +> **turnPassword**: `undefined` \| `string` = `credential` + +### turnServer + +> **turnServer**: `undefined` \| readonly [`string`, `number`] + +### turnUsername + +> **turnUsername**: `undefined` \| `string` = `username` diff --git a/doc/functions/parseMessage.md b/doc/functions/parseMessage.md new file mode 100644 index 000000000..436c03bc3 --- /dev/null +++ b/doc/functions/parseMessage.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / parseMessage + +# Function: parseMessage() + +> **parseMessage**(`data`, `integrityKey`?): [`Message`](../classes/Message.md) \| `undefined` + +## Parameters + +• **data**: `Buffer` + +• **integrityKey?**: `Buffer` + +## Returns + +[`Message`](../classes/Message.md) \| `undefined` diff --git a/doc/functions/random16.md b/doc/functions/random16.md new file mode 100644 index 000000000..bd536b654 --- /dev/null +++ b/doc/functions/random16.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / random16 + +# Function: random16() + +> **random16**(): `number` + +## Returns + +`number` diff --git a/doc/functions/random32.md b/doc/functions/random32.md new file mode 100644 index 000000000..c7c7560ee --- /dev/null +++ b/doc/functions/random32.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / random32 + +# Function: random32() + +> **random32**(): `number` + +## Returns + +`number` diff --git a/doc/functions/randomPort.md b/doc/functions/randomPort.md new file mode 100644 index 000000000..3e6a9fd91 --- /dev/null +++ b/doc/functions/randomPort.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / randomPort + +# Function: randomPort() + +> **randomPort**(`protocol`, `interfaceAddresses`?): `Promise`\<`number`\> + +## Parameters + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`\> diff --git a/doc/functions/randomPorts.md b/doc/functions/randomPorts.md new file mode 100644 index 000000000..0463a8515 --- /dev/null +++ b/doc/functions/randomPorts.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / randomPorts + +# Function: randomPorts() + +> **randomPorts**(`num`, `protocol`, `interfaceAddresses`?): `Promise`\<`number`[]\> + +## Parameters + +• **num**: `number` + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`[]\> diff --git a/doc/functions/reverseDirection.md b/doc/functions/reverseDirection.md new file mode 100644 index 000000000..19ddf394b --- /dev/null +++ b/doc/functions/reverseDirection.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / reverseDirection + +# Function: reverseDirection() + +> **reverseDirection**(`dir`): [`Direction`](../type-aliases/Direction.md) + +## Parameters + +• **dir**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` + +## Returns + +[`Direction`](../type-aliases/Direction.md) diff --git a/doc/functions/reverseSimulcastDirection.md b/doc/functions/reverseSimulcastDirection.md new file mode 100644 index 000000000..f214f7222 --- /dev/null +++ b/doc/functions/reverseSimulcastDirection.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / reverseSimulcastDirection + +# Function: reverseSimulcastDirection() + +> **reverseSimulcastDirection**(`dir`): `"send"` \| `"recv"` + +## Parameters + +• **dir**: `"send"` \| `"recv"` + +## Returns + +`"send"` \| `"recv"` diff --git a/doc/functions/rtpHeaderExtensionsParser.md b/doc/functions/rtpHeaderExtensionsParser.md new file mode 100644 index 000000000..82b3d7573 --- /dev/null +++ b/doc/functions/rtpHeaderExtensionsParser.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / rtpHeaderExtensionsParser + +# Function: rtpHeaderExtensionsParser() + +> **rtpHeaderExtensionsParser**(`extensions`, `extIdUriMap`): `object` + +## Parameters + +• **extensions**: [`Extension`](../type-aliases/Extension.md)[] + +• **extIdUriMap** + +## Returns + +`object` diff --git a/doc/functions/serializeAbsSendTime.md b/doc/functions/serializeAbsSendTime.md new file mode 100644 index 000000000..d680de16b --- /dev/null +++ b/doc/functions/serializeAbsSendTime.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeAbsSendTime + +# Function: serializeAbsSendTime() + +> **serializeAbsSendTime**(`ntpTime`): `Buffer` + +## Parameters + +• **ntpTime**: `bigint` + +## Returns + +`Buffer` diff --git a/doc/functions/serializeAudioLevelIndication.md b/doc/functions/serializeAudioLevelIndication.md new file mode 100644 index 000000000..f63c2f962 --- /dev/null +++ b/doc/functions/serializeAudioLevelIndication.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeAudioLevelIndication + +# Function: serializeAudioLevelIndication() + +> **serializeAudioLevelIndication**(`level`): `Buffer` + +## Parameters + +• **level**: `number` + +## Returns + +`Buffer` diff --git a/doc/functions/serializeRepairedRtpStreamId.md b/doc/functions/serializeRepairedRtpStreamId.md new file mode 100644 index 000000000..181d629aa --- /dev/null +++ b/doc/functions/serializeRepairedRtpStreamId.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeRepairedRtpStreamId + +# Function: serializeRepairedRtpStreamId() + +> **serializeRepairedRtpStreamId**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/doc/functions/serializeSdesMid.md b/doc/functions/serializeSdesMid.md new file mode 100644 index 000000000..d3900211a --- /dev/null +++ b/doc/functions/serializeSdesMid.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeSdesMid + +# Function: serializeSdesMid() + +> **serializeSdesMid**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/doc/functions/serializeSdesRTPStreamID.md b/doc/functions/serializeSdesRTPStreamID.md new file mode 100644 index 000000000..31a0d74cb --- /dev/null +++ b/doc/functions/serializeSdesRTPStreamID.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeSdesRTPStreamID + +# Function: serializeSdesRTPStreamID() + +> **serializeSdesRTPStreamID**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/doc/functions/serializeTransportWideCC.md b/doc/functions/serializeTransportWideCC.md new file mode 100644 index 000000000..82c422908 --- /dev/null +++ b/doc/functions/serializeTransportWideCC.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serializeTransportWideCC + +# Function: serializeTransportWideCC() + +> **serializeTransportWideCC**(`transportSequenceNumber`): `Buffer` + +## Parameters + +• **transportSequenceNumber**: `number` + +## Returns + +`Buffer` diff --git a/doc/functions/serverReflexiveCandidate.md b/doc/functions/serverReflexiveCandidate.md new file mode 100644 index 000000000..87ab302d5 --- /dev/null +++ b/doc/functions/serverReflexiveCandidate.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / serverReflexiveCandidate + +# Function: serverReflexiveCandidate() + +> **serverReflexiveCandidate**(`protocol`, `stunServer`): `Promise`\<`undefined` \| [`Candidate`](../classes/Candidate.md)\> + +## Parameters + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +• **stunServer**: readonly [`string`, `number`] + +## Returns + +`Promise`\<`undefined` \| [`Candidate`](../classes/Candidate.md)\> diff --git a/doc/functions/sortCandidatePairs.md b/doc/functions/sortCandidatePairs.md new file mode 100644 index 000000000..562e152aa --- /dev/null +++ b/doc/functions/sortCandidatePairs.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / sortCandidatePairs + +# Function: sortCandidatePairs() + +> **sortCandidatePairs**(`pairs`, `iceControlling`): `object`[] + +## Parameters + +• **pairs**: `object`[] + +• **iceControlling**: `boolean` + +## Returns + +`object`[] diff --git a/doc/functions/timestampSeconds.md b/doc/functions/timestampSeconds.md new file mode 100644 index 000000000..790705a54 --- /dev/null +++ b/doc/functions/timestampSeconds.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / timestampSeconds + +# Function: timestampSeconds() + +> **timestampSeconds**(): `number` + +## Returns + +`number` diff --git a/doc/functions/uint16Add.md b/doc/functions/uint16Add.md new file mode 100644 index 000000000..25adee12a --- /dev/null +++ b/doc/functions/uint16Add.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint16Add + +# Function: uint16Add() + +> **uint16Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/doc/functions/uint16Gt.md b/doc/functions/uint16Gt.md new file mode 100644 index 000000000..41ee0fbf4 --- /dev/null +++ b/doc/functions/uint16Gt.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint16Gt + +# Function: uint16Gt() + +> **uint16Gt**(`a`, `b`): `boolean` + +Return a > b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/doc/functions/uint16Gte.md b/doc/functions/uint16Gte.md new file mode 100644 index 000000000..5b7cce169 --- /dev/null +++ b/doc/functions/uint16Gte.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint16Gte + +# Function: uint16Gte() + +> **uint16Gte**(`a`, `b`): `boolean` + +Return a >= b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/doc/functions/uint24.md b/doc/functions/uint24.md new file mode 100644 index 000000000..d7733d2db --- /dev/null +++ b/doc/functions/uint24.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint24 + +# Function: uint24() + +> **uint24**(`v`): `number` + +## Parameters + +• **v**: `number` + +## Returns + +`number` diff --git a/doc/functions/uint32Add.md b/doc/functions/uint32Add.md new file mode 100644 index 000000000..8551e3730 --- /dev/null +++ b/doc/functions/uint32Add.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint32Add + +# Function: uint32Add() + +> **uint32Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/doc/functions/uint32Gt.md b/doc/functions/uint32Gt.md new file mode 100644 index 000000000..dc74e52f3 --- /dev/null +++ b/doc/functions/uint32Gt.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint32Gt + +# Function: uint32Gt() + +> **uint32Gt**(`a`, `b`): `boolean` + +Return a > b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/doc/functions/uint32Gte.md b/doc/functions/uint32Gte.md new file mode 100644 index 000000000..f1f46fe77 --- /dev/null +++ b/doc/functions/uint32Gte.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint32Gte + +# Function: uint32Gte() + +> **uint32Gte**(`a`, `b`): `boolean` + +Return a >= b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/doc/functions/uint8Add.md b/doc/functions/uint8Add.md new file mode 100644 index 000000000..e0a81081a --- /dev/null +++ b/doc/functions/uint8Add.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / uint8Add + +# Function: uint8Add() + +> **uint8Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/doc/functions/unwrapRtx.md b/doc/functions/unwrapRtx.md new file mode 100644 index 000000000..ba075c6b5 --- /dev/null +++ b/doc/functions/unwrapRtx.md @@ -0,0 +1,21 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / unwrapRtx + +# Function: unwrapRtx() + +> **unwrapRtx**(`rtx`, `payloadType`, `ssrc`): [`RtpPacket`](../classes/RtpPacket.md) + +## Parameters + +• **rtx**: [`RtpPacket`](../classes/RtpPacket.md) + +• **payloadType**: `number` + +• **ssrc**: `number` + +## Returns + +[`RtpPacket`](../classes/RtpPacket.md) diff --git a/doc/functions/url2Address.md b/doc/functions/url2Address.md new file mode 100644 index 000000000..6cbfba459 --- /dev/null +++ b/doc/functions/url2Address.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / url2Address + +# Function: url2Address() + +> **url2Address**(`url`?): `undefined` \| readonly [`string`, `number`] + +## Parameters + +• **url?**: `string` + +## Returns + +`undefined` \| readonly [`string`, `number`] diff --git a/doc/functions/useAbsSendTime.md b/doc/functions/useAbsSendTime.md new file mode 100644 index 000000000..512cdfd3d --- /dev/null +++ b/doc/functions/useAbsSendTime.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useAbsSendTime + +# Function: useAbsSendTime() + +> **useAbsSendTime**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useAudioLevelIndication.md b/doc/functions/useAudioLevelIndication.md new file mode 100644 index 000000000..c0d4700c0 --- /dev/null +++ b/doc/functions/useAudioLevelIndication.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useAudioLevelIndication + +# Function: useAudioLevelIndication() + +> **useAudioLevelIndication**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useDependencyDescriptor.md b/doc/functions/useDependencyDescriptor.md new file mode 100644 index 000000000..9885bf0d6 --- /dev/null +++ b/doc/functions/useDependencyDescriptor.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useDependencyDescriptor + +# Function: useDependencyDescriptor() + +> **useDependencyDescriptor**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useFIR.md b/doc/functions/useFIR.md new file mode 100644 index 000000000..0c87403d2 --- /dev/null +++ b/doc/functions/useFIR.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useFIR + +# Function: useFIR() + +> **useFIR**(): [`RTCPFB`](../type-aliases/RTCPFB.md) + +## Returns + +[`RTCPFB`](../type-aliases/RTCPFB.md) diff --git a/doc/functions/useNACK.md b/doc/functions/useNACK.md new file mode 100644 index 000000000..37553fdce --- /dev/null +++ b/doc/functions/useNACK.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useNACK + +# Function: useNACK() + +> **useNACK**(): [`RTCPFB`](../type-aliases/RTCPFB.md) + +## Returns + +[`RTCPFB`](../type-aliases/RTCPFB.md) diff --git a/doc/functions/usePLI.md b/doc/functions/usePLI.md new file mode 100644 index 000000000..d811cdb95 --- /dev/null +++ b/doc/functions/usePLI.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / usePLI + +# Function: usePLI() + +> **usePLI**(): [`RTCPFB`](../type-aliases/RTCPFB.md) + +## Returns + +[`RTCPFB`](../type-aliases/RTCPFB.md) diff --git a/doc/functions/useREMB.md b/doc/functions/useREMB.md new file mode 100644 index 000000000..ab24dd229 --- /dev/null +++ b/doc/functions/useREMB.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useREMB + +# Function: useREMB() + +> **useREMB**(): [`RTCPFB`](../type-aliases/RTCPFB.md) + +## Returns + +[`RTCPFB`](../type-aliases/RTCPFB.md) diff --git a/doc/functions/useRepairedRtpStreamId.md b/doc/functions/useRepairedRtpStreamId.md new file mode 100644 index 000000000..d0f927924 --- /dev/null +++ b/doc/functions/useRepairedRtpStreamId.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useRepairedRtpStreamId + +# Function: useRepairedRtpStreamId() + +> **useRepairedRtpStreamId**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useSdesMid.md b/doc/functions/useSdesMid.md new file mode 100644 index 000000000..cd7830f7d --- /dev/null +++ b/doc/functions/useSdesMid.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useSdesMid + +# Function: useSdesMid() + +> **useSdesMid**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useSdesRTPStreamId.md b/doc/functions/useSdesRTPStreamId.md new file mode 100644 index 000000000..e0b675996 --- /dev/null +++ b/doc/functions/useSdesRTPStreamId.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useSdesRTPStreamId + +# Function: useSdesRTPStreamId() + +> **useSdesRTPStreamId**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/useTWCC.md b/doc/functions/useTWCC.md new file mode 100644 index 000000000..407a29c36 --- /dev/null +++ b/doc/functions/useTWCC.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useTWCC + +# Function: useTWCC() + +> **useTWCC**(): [`RTCPFB`](../type-aliases/RTCPFB.md) + +## Returns + +[`RTCPFB`](../type-aliases/RTCPFB.md) diff --git a/doc/functions/useTransportWideCC.md b/doc/functions/useTransportWideCC.md new file mode 100644 index 000000000..b0440a327 --- /dev/null +++ b/doc/functions/useTransportWideCC.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / useTransportWideCC + +# Function: useTransportWideCC() + +> **useTransportWideCC**(): [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) + +## Returns + +[`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md) diff --git a/doc/functions/validateAddress.md b/doc/functions/validateAddress.md new file mode 100644 index 000000000..e4a937749 --- /dev/null +++ b/doc/functions/validateAddress.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / validateAddress + +# Function: validateAddress() + +> **validateAddress**(`addr`?): [`Address`](../type-aliases/Address.md) \| `undefined` + +## Parameters + +• **addr?**: readonly [`string`, `number`] + +## Returns + +[`Address`](../type-aliases/Address.md) \| `undefined` diff --git a/doc/functions/validateRemoteCandidate.md b/doc/functions/validateRemoteCandidate.md new file mode 100644 index 000000000..699cdebf8 --- /dev/null +++ b/doc/functions/validateRemoteCandidate.md @@ -0,0 +1,17 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / validateRemoteCandidate + +# Function: validateRemoteCandidate() + +> **validateRemoteCandidate**(`candidate`): [`Candidate`](../classes/Candidate.md) + +## Parameters + +• **candidate**: [`Candidate`](../classes/Candidate.md) + +## Returns + +[`Candidate`](../classes/Candidate.md) diff --git a/doc/functions/wrapRtx.md b/doc/functions/wrapRtx.md new file mode 100644 index 000000000..25a6c3a6f --- /dev/null +++ b/doc/functions/wrapRtx.md @@ -0,0 +1,23 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / wrapRtx + +# Function: wrapRtx() + +> **wrapRtx**(`packet`, `payloadType`, `sequenceNumber`, `ssrc`): [`RtpPacket`](../classes/RtpPacket.md) + +## Parameters + +• **packet**: [`RtpPacket`](../classes/RtpPacket.md) + +• **payloadType**: `number` + +• **sequenceNumber**: `number` + +• **ssrc**: `number` + +## Returns + +[`RtpPacket`](../classes/RtpPacket.md) diff --git a/doc/globals.md b/doc/globals.md new file mode 100644 index 000000000..fb178afb8 --- /dev/null +++ b/doc/globals.md @@ -0,0 +1,295 @@ +[**werift**](README.md) • **Docs** + +*** + +# werift + +## Enumerations + +- [CandidatePairState](enumerations/CandidatePairState.md) +- [PacketChunk](enumerations/PacketChunk.md) +- [PacketStatus](enumerations/PacketStatus.md) +- [classes](enumerations/classes.md) +- [methods](enumerations/methods.md) + +## Classes + +- [AV1Obu](classes/AV1Obu.md) +- [AV1RtpPayload](classes/AV1RtpPayload.md) +- [BitStream](classes/BitStream.md) +- [BitWriter](classes/BitWriter.md) +- [BitWriter2](classes/BitWriter2.md) +- [BufferChain](classes/BufferChain.md) +- [Candidate](classes/Candidate.md) +- [CandidatePair](classes/CandidatePair.md) +- [Connection](classes/Connection.md) +- [DePacketizerBase](classes/DePacketizerBase.md) +- [Event](classes/Event.md) +- [EventDisposer](classes/EventDisposer.md) +- [GenericNack](classes/GenericNack.md) +- [GroupDescription](classes/GroupDescription.md) +- [H264RtpPayload](classes/H264RtpPayload.md) +- [IceCandidate](classes/IceCandidate.md) +- [MediaDescription](classes/MediaDescription.md) +- [MediaStream](classes/MediaStream.md) +- [MediaStreamTrack](classes/MediaStreamTrack.md) +- [MediaStreamTrackFactory](classes/MediaStreamTrackFactory.md) +- [Message](classes/Message.md) +- [OpusRtpPayload](classes/OpusRtpPayload.md) +- [PacketResult](classes/PacketResult.md) +- [PictureLossIndication](classes/PictureLossIndication.md) +- [PromiseQueue](classes/PromiseQueue.md) +- [RTCCertificate](classes/RTCCertificate.md) +- [RTCDataChannel](classes/RTCDataChannel.md) +- [RTCDataChannelParameters](classes/RTCDataChannelParameters.md) +- [RTCDtlsFingerprint](classes/RTCDtlsFingerprint.md) +- [RTCDtlsParameters](classes/RTCDtlsParameters.md) +- [RTCDtlsTransport](classes/RTCDtlsTransport.md) +- [RTCIceCandidate](classes/RTCIceCandidate.md) +- [RTCIceGatherer](classes/RTCIceGatherer.md) +- [RTCIceParameters](classes/RTCIceParameters.md) +- [RTCIceTransport](classes/RTCIceTransport.md) +- [RTCPeerConnection](classes/RTCPeerConnection.md) +- [RTCRtcpFeedback](classes/RTCRtcpFeedback.md) +- [RTCRtcpParameters](classes/RTCRtcpParameters.md) +- [RTCRtpCodecParameters](classes/RTCRtpCodecParameters.md) +- [RTCRtpCodingParameters](classes/RTCRtpCodingParameters.md) +- [RTCRtpHeaderExtensionParameters](classes/RTCRtpHeaderExtensionParameters.md) +- [RTCRtpReceiver](classes/RTCRtpReceiver.md) +- [RTCRtpRtxParameters](classes/RTCRtpRtxParameters.md) +- [RTCRtpSender](classes/RTCRtpSender.md) +- [RTCRtpSimulcastParameters](classes/RTCRtpSimulcastParameters.md) +- [RTCRtpTransceiver](classes/RTCRtpTransceiver.md) +- [RTCSctpCapabilities](classes/RTCSctpCapabilities.md) +- [RTCSctpTransport](classes/RTCSctpTransport.md) +- [RTCSessionDescription](classes/RTCSessionDescription.md) +- [ReceiverEstimatedMaxBitrate](classes/ReceiverEstimatedMaxBitrate.md) +- [RecvDelta](classes/RecvDelta.md) +- [Red](classes/Red.md) +- [RedEncoder](classes/RedEncoder.md) +- [RedHandler](classes/RedHandler.md) +- [RedHeader](classes/RedHeader.md) +- [RtcpHeader](classes/RtcpHeader.md) +- [RtcpPacketConverter](classes/RtcpPacketConverter.md) +- [RtcpPayloadSpecificFeedback](classes/RtcpPayloadSpecificFeedback.md) +- [RtcpReceiverInfo](classes/RtcpReceiverInfo.md) +- [RtcpRrPacket](classes/RtcpRrPacket.md) +- [RtcpSenderInfo](classes/RtcpSenderInfo.md) +- [RtcpSourceDescriptionPacket](classes/RtcpSourceDescriptionPacket.md) +- [RtcpSrPacket](classes/RtcpSrPacket.md) +- [RtcpTransportLayerFeedback](classes/RtcpTransportLayerFeedback.md) +- [RtpBuilder](classes/RtpBuilder.md) +- [RtpHeader](classes/RtpHeader.md) +- [RtpPacket](classes/RtpPacket.md) +- [RunLengthChunk](classes/RunLengthChunk.md) +- [SessionDescription](classes/SessionDescription.md) +- [SourceDescriptionChunk](classes/SourceDescriptionChunk.md) +- [SourceDescriptionItem](classes/SourceDescriptionItem.md) +- [SrtcpSession](classes/SrtcpSession.md) +- [SrtpSession](classes/SrtpSession.md) +- [SsrcDescription](classes/SsrcDescription.md) +- [StatusVectorChunk](classes/StatusVectorChunk.md) +- [StunOverTurnProtocol](classes/StunOverTurnProtocol.md) +- [StunProtocol](classes/StunProtocol.md) +- [TcpTransport](classes/TcpTransport.md) +- [TransportWideCC](classes/TransportWideCC.md) +- [TurnProtocol](classes/TurnProtocol.md) +- [UdpTransport](classes/UdpTransport.md) +- [Vp8RtpPayload](classes/Vp8RtpPayload.md) +- [Vp9RtpPayload](classes/Vp9RtpPayload.md) +- [WeriftError](classes/WeriftError.md) + +## Interfaces + +- [IceOptions](interfaces/IceOptions.md) +- [MessageEvent](interfaces/MessageEvent.md) +- [PeerConfig](interfaces/PeerConfig.md) +- [Protocol](interfaces/Protocol.md) +- [RTCDataChannelEvent](interfaces/RTCDataChannelEvent.md) +- [RTCErrorEvent](interfaces/RTCErrorEvent.md) +- [RTCPeerConnectionIceEvent](interfaces/RTCPeerConnectionIceEvent.md) +- [RTCRtpParameters](interfaces/RTCRtpParameters.md) +- [RTCRtpReceiveParameters](interfaces/RTCRtpReceiveParameters.md) +- [RTCSessionDescriptionInit](interfaces/RTCSessionDescriptionInit.md) +- [RTCTrackEvent](interfaces/RTCTrackEvent.md) +- [TransceiverOptions](interfaces/TransceiverOptions.md) +- [Transport](interfaces/Transport.md) +- [TurnClientConfig](interfaces/TurnClientConfig.md) +- [TurnClientOptions](interfaces/TurnClientOptions.md) + +## Type Aliases + +- [Address](type-aliases/Address.md) +- [AudioLevelIndicationPayload](type-aliases/AudioLevelIndicationPayload.md) +- [BundlePolicy](type-aliases/BundlePolicy.md) +- [CipherSuites](type-aliases/CipherSuites.md) +- [ConnectionState](type-aliases/ConnectionState.md) +- [CurveTypes](type-aliases/CurveTypes.md) +- [DCState](type-aliases/DCState.md) +- [DepacketizerCodec](type-aliases/DepacketizerCodec.md) +- [Direction](type-aliases/Direction.md) +- [DtlsKeys](type-aliases/DtlsKeys.md) +- [DtlsRole](type-aliases/DtlsRole.md) +- [DtlsState](type-aliases/DtlsState.md) +- [Extension](type-aliases/Extension.md) +- [HashAlgorithms](type-aliases/HashAlgorithms.md) +- [IceGathererState](type-aliases/IceGathererState.md) +- [InterfaceAddresses](type-aliases/InterfaceAddresses.md) +- [Kind](type-aliases/Kind.md) +- [NamedCurveAlgorithms](type-aliases/NamedCurveAlgorithms.md) +- [RTCIceConnectionState](type-aliases/RTCIceConnectionState.md) +- [RTCIceServer](type-aliases/RTCIceServer.md) +- [RTCPFB](type-aliases/RTCPFB.md) +- [RTCRtpSendParameters](type-aliases/RTCRtpSendParameters.md) +- [RTCSdpType](type-aliases/RTCSdpType.md) +- [RTCSignalingState](type-aliases/RTCSignalingState.md) +- [RequireAtLeastOne](type-aliases/RequireAtLeastOne.md) +- [RtcpPacket](type-aliases/RtcpPacket.md) +- [SignatureAlgorithms](type-aliases/SignatureAlgorithms.md) +- [SignatureHash](type-aliases/SignatureHash.md) +- [SignatureSchemes](type-aliases/SignatureSchemes.md) +- [TransportWideCCPayload](type-aliases/TransportWideCCPayload.md) + +## Variables + +- [AttributeKeys](variables/AttributeKeys.md) +- [COOKIE](variables/COOKIE.md) +- [CipherSuite](variables/CipherSuite.md) +- [CipherSuiteList](variables/CipherSuiteList.md) +- [ConnectionStates](variables/ConnectionStates.md) +- [CurveType](variables/CurveType.md) +- [Directions](variables/Directions.md) +- [DtlsStates](variables/DtlsStates.md) +- [ExtensionProfiles](variables/ExtensionProfiles.md) +- [FINGERPRINT\_LENGTH](variables/FINGERPRINT_LENGTH.md) +- [FINGERPRINT\_XOR](variables/FINGERPRINT_XOR.md) +- [HEADER\_LENGTH](variables/HEADER_LENGTH.md) +- [HashAlgorithm](variables/HashAlgorithm.md) +- [INTEGRITY\_LENGTH](variables/INTEGRITY_LENGTH.md) +- [IPV4\_PROTOCOL](variables/IPV4_PROTOCOL.md) +- [IPV6\_PROTOCOL](variables/IPV6_PROTOCOL.md) +- [IceGathererStates](variables/IceGathererStates.md) +- [IceTransportStates](variables/IceTransportStates.md) +- [Inactive](variables/Inactive.md) +- [NalUnitType](variables/NalUnitType.md) +- [NamedCurveAlgorithm](variables/NamedCurveAlgorithm.md) +- [NamedCurveAlgorithmList](variables/NamedCurveAlgorithmList.md) +- [RETRY\_MAX](variables/RETRY_MAX.md) +- [RETRY\_RTO](variables/RETRY_RTO.md) +- [RTCP\_HEADER\_SIZE](variables/RTCP_HEADER_SIZE.md) +- [RTP\_EXTENSION\_URI](variables/RTP_EXTENSION_URI.md) +- [Recvonly](variables/Recvonly.md) +- [Sendonly](variables/Sendonly.md) +- [Sendrecv](variables/Sendrecv.md) +- [SignalingStates](variables/SignalingStates.md) +- [SignatureAlgorithm](variables/SignatureAlgorithm.md) +- [SignatureScheme](variables/SignatureScheme.md) +- [certificateTypes](variables/certificateTypes.md) +- [defaultPeerConfig](variables/defaultPeerConfig.md) +- [depacketizerCodecs](variables/depacketizerCodecs.md) +- [signatures](variables/signatures.md) +- [timer](variables/timer.md) + +## Functions + +- [Int](functions/Int.md) +- [addSDPHeader](functions/addSDPHeader.md) +- [addTransportDescription](functions/addTransportDescription.md) +- [allocateMid](functions/allocateMid.md) +- [andDirection](functions/andDirection.md) +- [buffer2ArrayBuffer](functions/buffer2ArrayBuffer.md) +- [bufferArrayXor](functions/bufferArrayXor.md) +- [bufferReader](functions/bufferReader.md) +- [bufferWriter](functions/bufferWriter.md) +- [bufferWriterLE](functions/bufferWriterLE.md) +- [bufferXor](functions/bufferXor.md) +- [candidateFoundation](functions/candidateFoundation.md) +- [candidateFromIce](functions/candidateFromIce.md) +- [candidateFromSdp](functions/candidateFromSdp.md) +- [candidatePairPriority](functions/candidatePairPriority.md) +- [candidatePriority](functions/candidatePriority.md) +- [candidateToIce](functions/candidateToIce.md) +- [candidateToSdp](functions/candidateToSdp.md) +- [codecParametersFromString](functions/codecParametersFromString.md) +- [codecParametersToString](functions/codecParametersToString.md) +- [compactNtp](functions/compactNtp.md) +- [createBufferWriter](functions/createBufferWriter.md) +- [createMediaDescriptionForSctp](functions/createMediaDescriptionForSctp.md) +- [createMediaDescriptionForTransceiver](functions/createMediaDescriptionForTransceiver.md) +- [createSelfSignedCertificate](functions/createSelfSignedCertificate.md) +- [createStunOverTurnClient](functions/createStunOverTurnClient.md) +- [createTurnClient](functions/createTurnClient.md) +- [dePacketizeRtpPackets](functions/dePacketizeRtpPackets.md) +- [deepMerge](functions/deepMerge.md) +- [deserializeAbsSendTime](functions/deserializeAbsSendTime.md) +- [deserializeAudioLevelIndication](functions/deserializeAudioLevelIndication.md) +- [deserializeString](functions/deserializeString.md) +- [deserializeUint16BE](functions/deserializeUint16BE.md) +- [dumpBuffer](functions/dumpBuffer.md) +- [enumerate](functions/enumerate.md) +- [findCodecByMimeType](functions/findCodecByMimeType.md) +- [findPort](functions/findPort.md) +- [fingerprint](functions/fingerprint.md) +- [getBit](functions/getBit.md) +- [getGlobalIp](functions/getGlobalIp.md) +- [getHostAddresses](functions/getHostAddresses.md) +- [growBufferSize](functions/growBufferSize.md) +- [int](functions/int-1.md) +- [interfaceAddress](functions/interfaceAddress.md) +- [isDtls](functions/isDtls.md) +- [isMedia](functions/isMedia.md) +- [isRtcp](functions/isRtcp.md) +- [leb128decode](functions/leb128decode.md) +- [makeIntegrityKey](functions/makeIntegrityKey.md) +- [microTime](functions/microTime.md) +- [milliTime](functions/milliTime.md) +- [normalizeFamilyNodeV18](functions/normalizeFamilyNodeV18.md) +- [ntpTime](functions/ntpTime.md) +- [ntpTime2Sec](functions/ntpTime2Sec.md) +- [paddingBits](functions/paddingBits.md) +- [paddingByte](functions/paddingByte.md) +- [paddingLength](functions/paddingLength.md) +- [parseGroup](functions/parseGroup.md) +- [parseIceServers](functions/parseIceServers.md) +- [parseMessage](functions/parseMessage.md) +- [random16](functions/random16.md) +- [random32](functions/random32.md) +- [randomPort](functions/randomPort.md) +- [randomPorts](functions/randomPorts.md) +- [reverseDirection](functions/reverseDirection.md) +- [reverseSimulcastDirection](functions/reverseSimulcastDirection.md) +- [rtpHeaderExtensionsParser](functions/rtpHeaderExtensionsParser.md) +- [serializeAbsSendTime](functions/serializeAbsSendTime.md) +- [serializeAudioLevelIndication](functions/serializeAudioLevelIndication.md) +- [serializeRepairedRtpStreamId](functions/serializeRepairedRtpStreamId.md) +- [serializeSdesMid](functions/serializeSdesMid.md) +- [serializeSdesRTPStreamID](functions/serializeSdesRTPStreamID.md) +- [serializeTransportWideCC](functions/serializeTransportWideCC.md) +- [serverReflexiveCandidate](functions/serverReflexiveCandidate.md) +- [sortCandidatePairs](functions/sortCandidatePairs.md) +- [timestampSeconds](functions/timestampSeconds.md) +- [uint16Add](functions/uint16Add.md) +- [uint16Gt](functions/uint16Gt.md) +- [uint16Gte](functions/uint16Gte.md) +- [uint24](functions/uint24.md) +- [uint32Add](functions/uint32Add.md) +- [uint32Gt](functions/uint32Gt.md) +- [uint32Gte](functions/uint32Gte.md) +- [uint8Add](functions/uint8Add.md) +- [unwrapRtx](functions/unwrapRtx.md) +- [url2Address](functions/url2Address.md) +- [useAbsSendTime](functions/useAbsSendTime.md) +- [useAudioLevelIndication](functions/useAudioLevelIndication.md) +- [useDependencyDescriptor](functions/useDependencyDescriptor.md) +- [useFIR](functions/useFIR.md) +- [useNACK](functions/useNACK.md) +- [usePLI](functions/usePLI.md) +- [useREMB](functions/useREMB.md) +- [useRepairedRtpStreamId](functions/useRepairedRtpStreamId.md) +- [useSdesMid](functions/useSdesMid.md) +- [useSdesRTPStreamId](functions/useSdesRTPStreamId.md) +- [useTWCC](functions/useTWCC.md) +- [useTransportWideCC](functions/useTransportWideCC.md) +- [validateAddress](functions/validateAddress.md) +- [validateRemoteCandidate](functions/validateRemoteCandidate.md) +- [wrapRtx](functions/wrapRtx.md) diff --git a/doc/interfaces/IceOptions.md b/doc/interfaces/IceOptions.md index 3bb0f7cb0..d37c7a8a0 100644 --- a/doc/interfaces/IceOptions.md +++ b/doc/interfaces/IceOptions.md @@ -1,143 +1,111 @@ -[werift](../README.md) / [Exports](../modules.md) / IceOptions +[**werift**](../README.md) • **Docs** -# Interface: IceOptions - -## Table of contents - -### Properties - -- [additionalHostAddresses](IceOptions.md#additionalhostaddresses) -- [components](IceOptions.md#components) -- [filterCandidatePair](IceOptions.md#filtercandidatepair) -- [filterStunResponse](IceOptions.md#filterstunresponse) -- [forceTurn](IceOptions.md#forceturn) -- [interfaceAddresses](IceOptions.md#interfaceaddresses) -- [portRange](IceOptions.md#portrange) -- [stunServer](IceOptions.md#stunserver) -- [turnPassword](IceOptions.md#turnpassword) -- [turnServer](IceOptions.md#turnserver) -- [turnSsl](IceOptions.md#turnssl) -- [turnTransport](IceOptions.md#turntransport) -- [turnUsername](IceOptions.md#turnusername) -- [useIpv4](IceOptions.md#useipv4) -- [useIpv6](IceOptions.md#useipv6) - -## Properties +*** -### additionalHostAddresses +[werift](../globals.md) / IceOptions -• `Optional` **additionalHostAddresses**: `string`[] - -___ - -### components +# Interface: IceOptions -• **components**: `number` +## Properties -___ +### additionalHostAddresses? -### filterCandidatePair +> `optional` **additionalHostAddresses**: `string`[] -• `Optional` **filterCandidatePair**: (`pair`: [`CandidatePair`](../classes/CandidatePair.md)) => `boolean` +*** -#### Type declaration +### filterCandidatePair()? -▸ (`pair`): `boolean` +> `optional` **filterCandidatePair**: (`pair`) => `boolean` -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `pair` | [`CandidatePair`](../classes/CandidatePair.md) | +• **pair**: [`CandidatePair`](../classes/CandidatePair.md) -##### Returns +#### Returns `boolean` -___ +*** -### filterStunResponse +### filterStunResponse()? -• `Optional` **filterStunResponse**: (`message`: `Message`, `addr`: readonly [`string`, `number`], `protocol`: [`Protocol`](Protocol.md)) => `boolean` +> `optional` **filterStunResponse**: (`message`, `addr`, `protocol`) => `boolean` -#### Type declaration +#### Parameters -▸ (`message`, `addr`, `protocol`): `boolean` +• **message**: [`Message`](../classes/Message.md) -##### Parameters +• **addr**: readonly [`string`, `number`] -| Name | Type | -| :------ | :------ | -| `message` | `Message` | -| `addr` | readonly [`string`, `number`] | -| `protocol` | [`Protocol`](Protocol.md) | +• **protocol**: [`Protocol`](Protocol.md) -##### Returns +#### Returns `boolean` -___ +*** -### forceTurn +### forceTurn? -• `Optional` **forceTurn**: `boolean` +> `optional` **forceTurn**: `boolean` -___ +*** -### interfaceAddresses +### interfaceAddresses? -• `Optional` **interfaceAddresses**: [`InterfaceAddresses`](../modules.md#interfaceaddresses) +> `optional` **interfaceAddresses**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) -___ +*** -### portRange +### portRange? -• `Optional` **portRange**: [`number`, `number`] +> `optional` **portRange**: [`number`, `number`] -___ +*** -### stunServer +### stunServer? -• `Optional` **stunServer**: readonly [`string`, `number`] +> `optional` **stunServer**: readonly [`string`, `number`] -___ +*** -### turnPassword +### turnPassword? -• `Optional` **turnPassword**: `string` +> `optional` **turnPassword**: `string` -___ +*** -### turnServer +### turnServer? -• `Optional` **turnServer**: readonly [`string`, `number`] +> `optional` **turnServer**: readonly [`string`, `number`] -___ +*** -### turnSsl +### turnSsl? -• `Optional` **turnSsl**: `boolean` +> `optional` **turnSsl**: `boolean` -___ +*** -### turnTransport +### turnTransport? -• `Optional` **turnTransport**: `string` +> `optional` **turnTransport**: `string` -___ +*** -### turnUsername +### turnUsername? -• `Optional` **turnUsername**: `string` +> `optional` **turnUsername**: `string` -___ +*** ### useIpv4 -• **useIpv4**: `boolean` +> **useIpv4**: `boolean` -___ +*** ### useIpv6 -• **useIpv6**: `boolean` +> **useIpv6**: `boolean` diff --git a/doc/interfaces/MessageEvent.md b/doc/interfaces/MessageEvent.md index 327a74c64..d5b71841f 100644 --- a/doc/interfaces/MessageEvent.md +++ b/doc/interfaces/MessageEvent.md @@ -1,15 +1,13 @@ -[werift](../README.md) / [Exports](../modules.md) / MessageEvent +[**werift**](../README.md) • **Docs** -# Interface: MessageEvent - -## Table of contents +*** -### Properties +[werift](../globals.md) / MessageEvent -- [data](MessageEvent.md#data) +# Interface: MessageEvent ## Properties ### data -• **data**: `string` \| `Buffer` +> **data**: `string` \| `Buffer` diff --git a/doc/interfaces/PeerConfig.md b/doc/interfaces/PeerConfig.md index bbede5d34..8f2d69346 100644 --- a/doc/interfaces/PeerConfig.md +++ b/doc/interfaces/PeerConfig.md @@ -1,121 +1,162 @@ -[werift](../README.md) / [Exports](../modules.md) / PeerConfig +[**werift**](../README.md) • **Docs** -# Interface: PeerConfig +*** + +[werift](../globals.md) / PeerConfig -## Table of contents - -### Properties - -- [bundlePolicy](PeerConfig.md#bundlepolicy) -- [codecs](PeerConfig.md#codecs) -- [debug](PeerConfig.md#debug) -- [dtls](PeerConfig.md#dtls) -- [headerExtensions](PeerConfig.md#headerextensions) -- [iceAdditionalHostAddresses](PeerConfig.md#iceadditionalhostaddresses) -- [iceFilterCandidatePair](PeerConfig.md#icefiltercandidatepair) -- [iceFilterStunResponse](PeerConfig.md#icefilterstunresponse) -- [iceInterfaceAddresses](PeerConfig.md#iceinterfaceaddresses) -- [icePortRange](PeerConfig.md#iceportrange) -- [iceServers](PeerConfig.md#iceservers) -- [iceTransportPolicy](PeerConfig.md#icetransportpolicy) -- [iceUseIpv4](PeerConfig.md#iceuseipv4) -- [iceUseIpv6](PeerConfig.md#iceuseipv6) -- [midSuffix](PeerConfig.md#midsuffix) +# Interface: PeerConfig ## Properties ### bundlePolicy -• **bundlePolicy**: [`BundlePolicy`](../modules.md#bundlepolicy) +> **bundlePolicy**: [`BundlePolicy`](../type-aliases/BundlePolicy.md) -___ +*** ### codecs -• **codecs**: `Partial`\<\{ `audio`: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] ; `video`: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] }\> +> **codecs**: `Partial`\<`object`\> + +#### Type declaration + +##### audio + +> **audio**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] + +When specifying a codec with a fixed payloadType such as PCMU, +it is necessary to set the correct PayloadType in RTCRtpCodecParameters in advance. + +##### video -___ +> **video**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] + +*** ### debug -• **debug**: `Partial`\<\{ `disableRecvRetransmit`: `boolean` ; `disableSendNack`: `boolean` ; `inboundPacketLoss`: `number` ; `outboundPacketLoss`: `number` ; `receiverReportDelay`: `number` }\> +> **debug**: `Partial`\<`object`\> + +#### Type declaration + +##### disableRecvRetransmit + +> **disableRecvRetransmit**: `boolean` + +##### disableSendNack + +> **disableSendNack**: `boolean` + +##### inboundPacketLoss + +> **inboundPacketLoss**: `number` -___ +% + +##### outboundPacketLoss + +> **outboundPacketLoss**: `number` + +% + +##### receiverReportDelay + +> **receiverReportDelay**: `number` + +ms + +*** ### dtls -• **dtls**: `Partial`\<\{ `keys`: [`DtlsKeys`](../modules.md#dtlskeys) }\> +> **dtls**: `Partial`\<`object`\> + +#### Type declaration -___ +##### keys + +> **keys**: [`DtlsKeys`](../type-aliases/DtlsKeys.md) + +*** ### headerExtensions -• **headerExtensions**: `Partial`\<\{ `audio`: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] ; `video`: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] }\> +> **headerExtensions**: `Partial`\<`object`\> + +#### Type declaration + +##### audio + +> **audio**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] + +##### video + +> **video**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] -___ +*** ### iceAdditionalHostAddresses -• **iceAdditionalHostAddresses**: `undefined` \| `string`[] +> **iceAdditionalHostAddresses**: `undefined` \| `string`[] Add additional host (local) addresses to use for candidate gathering. Notably, you can include hosts that are normally excluded, such as loopback, tun interfaces, etc. -___ +*** ### iceFilterCandidatePair -• **iceFilterCandidatePair**: `undefined` \| (`pair`: [`CandidatePair`](../classes/CandidatePair.md)) => `boolean` +> **iceFilterCandidatePair**: `undefined` \| (`pair`) => `boolean` -___ +*** ### iceFilterStunResponse -• **iceFilterStunResponse**: `undefined` \| (`message`: `Message`, `addr`: readonly [`string`, `number`], `protocol`: [`Protocol`](Protocol.md)) => `boolean` +> **iceFilterStunResponse**: `undefined` \| (`message`, `addr`, `protocol`) => `boolean` If provided, is called on each STUN request. Return `true` if a STUN response should be sent, false if it should be skipped. -___ +*** ### iceInterfaceAddresses -• **iceInterfaceAddresses**: `undefined` \| [`InterfaceAddresses`](../modules.md#interfaceaddresses) +> **iceInterfaceAddresses**: `undefined` \| [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) -___ +*** ### icePortRange -• **icePortRange**: `undefined` \| [`number`, `number`] +> **icePortRange**: `undefined` \| [`number`, `number`] Minimum port and Maximum port must not be the same value -___ +*** ### iceServers -• **iceServers**: [`RTCIceServer`](../modules.md#rtciceserver)[] +> **iceServers**: [`RTCIceServer`](../type-aliases/RTCIceServer.md)[] -___ +*** ### iceTransportPolicy -• **iceTransportPolicy**: ``"relay"`` \| ``"all"`` +> **iceTransportPolicy**: `"relay"` \| `"all"` -___ +*** ### iceUseIpv4 -• **iceUseIpv4**: `boolean` +> **iceUseIpv4**: `boolean` -___ +*** ### iceUseIpv6 -• **iceUseIpv6**: `boolean` +> **iceUseIpv6**: `boolean` -___ +*** ### midSuffix -• **midSuffix**: `boolean` +> **midSuffix**: `boolean` diff --git a/doc/interfaces/Protocol.md b/doc/interfaces/Protocol.md index 393669b29..cd252152f 100644 --- a/doc/interfaces/Protocol.md +++ b/doc/interfaces/Protocol.md @@ -1,147 +1,113 @@ -[werift](../README.md) / [Exports](../modules.md) / Protocol +[**werift**](../README.md) • **Docs** -# Interface: Protocol - -## Table of contents +*** -### Properties +[werift](../globals.md) / Protocol -- [close](Protocol.md#close) -- [connectionMade](Protocol.md#connectionmade) -- [localCandidate](Protocol.md#localcandidate) -- [request](Protocol.md#request) -- [responseAddr](Protocol.md#responseaddr) -- [responseMessage](Protocol.md#responsemessage) -- [sendData](Protocol.md#senddata) -- [sendStun](Protocol.md#sendstun) -- [sentMessage](Protocol.md#sentmessage) -- [type](Protocol.md#type) +# Interface: Protocol ## Properties -### close - -• `Optional` **close**: () => `Promise`\<`void`\> +### close() -#### Type declaration +> **close**: () => `Promise`\<`void`\> -▸ (): `Promise`\<`void`\> - -##### Returns +#### Returns `Promise`\<`void`\> -___ - -### connectionMade +*** -• **connectionMade**: (...`args`: `any`) => `Promise`\<`void`\> +### connectionMade() -#### Type declaration +> **connectionMade**: (...`args`) => `Promise`\<`void`\> -▸ (`...args`): `Promise`\<`void`\> +#### Parameters -##### Parameters +• ...**args**: `any` -| Name | Type | -| :------ | :------ | -| `...args` | `any` | - -##### Returns +#### Returns `Promise`\<`void`\> -___ +*** -### localCandidate +### localCandidate? -• `Optional` **localCandidate**: [`Candidate`](../classes/Candidate.md) +> `optional` **localCandidate**: [`Candidate`](../classes/Candidate.md) -___ +*** -### request +### request() -• **request**: (`message`: `Message`, `addr`: readonly [`string`, `number`], `integrityKey?`: `Buffer`, `retransmissions?`: `any`) => `Promise`\<[`Message`, readonly [`string`, `number`]]\> +> **request**: (`message`, `addr`, `integrityKey`?, `retransmissions`?) => `Promise`\<[[`Message`](../classes/Message.md), readonly [`string`, `number`]]\> -#### Type declaration +#### Parameters -▸ (`message`, `addr`, `integrityKey?`, `retransmissions?`): `Promise`\<[`Message`, readonly [`string`, `number`]]\> +• **message**: [`Message`](../classes/Message.md) -##### Parameters +• **addr**: readonly [`string`, `number`] -| Name | Type | -| :------ | :------ | -| `message` | `Message` | -| `addr` | readonly [`string`, `number`] | -| `integrityKey?` | `Buffer` | -| `retransmissions?` | `any` | +• **integrityKey?**: `Buffer` -##### Returns +• **retransmissions?**: `any` -`Promise`\<[`Message`, readonly [`string`, `number`]]\> +#### Returns -___ +`Promise`\<[[`Message`](../classes/Message.md), readonly [`string`, `number`]]\> -### responseAddr +*** -• `Optional` **responseAddr**: readonly [`string`, `number`] +### responseAddr? -___ +> `optional` **responseAddr**: readonly [`string`, `number`] -### responseMessage +*** -• `Optional` **responseMessage**: `string` +### responseMessage? -___ +> `optional` **responseMessage**: `string` -### sendData +*** -• **sendData**: (`data`: `Buffer`, `addr`: readonly [`string`, `number`]) => `Promise`\<`void`\> +### sendData() -#### Type declaration +> **sendData**: (`data`, `addr`) => `Promise`\<`void`\> -▸ (`data`, `addr`): `Promise`\<`void`\> +#### Parameters -##### Parameters +• **data**: `Buffer` -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `addr` | readonly [`string`, `number`] | +• **addr**: readonly [`string`, `number`] -##### Returns +#### Returns `Promise`\<`void`\> -___ - -### sendStun +*** -• **sendStun**: (`message`: `Message`, `addr`: readonly [`string`, `number`]) => `Promise`\<`void`\> +### sendStun() -#### Type declaration +> **sendStun**: (`message`, `addr`) => `Promise`\<`void`\> -▸ (`message`, `addr`): `Promise`\<`void`\> +#### Parameters -##### Parameters +• **message**: [`Message`](../classes/Message.md) -| Name | Type | -| :------ | :------ | -| `message` | `Message` | -| `addr` | readonly [`string`, `number`] | +• **addr**: readonly [`string`, `number`] -##### Returns +#### Returns `Promise`\<`void`\> -___ +*** -### sentMessage +### sentMessage? -• `Optional` **sentMessage**: `Message` +> `optional` **sentMessage**: [`Message`](../classes/Message.md) -___ +*** ### type -• **type**: `string` +> **type**: `string` diff --git a/doc/interfaces/RTCDataChannelEvent.md b/doc/interfaces/RTCDataChannelEvent.md index 54ef63317..19b245c6a 100644 --- a/doc/interfaces/RTCDataChannelEvent.md +++ b/doc/interfaces/RTCDataChannelEvent.md @@ -1,15 +1,13 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCDataChannelEvent +[**werift**](../README.md) • **Docs** -# Interface: RTCDataChannelEvent - -## Table of contents +*** -### Properties +[werift](../globals.md) / RTCDataChannelEvent -- [channel](RTCDataChannelEvent.md#channel) +# Interface: RTCDataChannelEvent ## Properties ### channel -• **channel**: [`RTCDataChannel`](../classes/RTCDataChannel.md) +> **channel**: [`RTCDataChannel`](../classes/RTCDataChannel.md) diff --git a/doc/interfaces/RTCErrorEvent.md b/doc/interfaces/RTCErrorEvent.md index 7c8d834f8..6013c20cd 100644 --- a/doc/interfaces/RTCErrorEvent.md +++ b/doc/interfaces/RTCErrorEvent.md @@ -1,15 +1,13 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCErrorEvent +[**werift**](../README.md) • **Docs** -# Interface: RTCErrorEvent - -## Table of contents +*** -### Properties +[werift](../globals.md) / RTCErrorEvent -- [error](RTCErrorEvent.md#error) +# Interface: RTCErrorEvent ## Properties ### error -• **error**: `any` +> **error**: `any` diff --git a/doc/interfaces/RTCPeerConnectionIceEvent.md b/doc/interfaces/RTCPeerConnectionIceEvent.md index 15d955d1b..faa6d2dd0 100644 --- a/doc/interfaces/RTCPeerConnectionIceEvent.md +++ b/doc/interfaces/RTCPeerConnectionIceEvent.md @@ -1,15 +1,13 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCPeerConnectionIceEvent +[**werift**](../README.md) • **Docs** -# Interface: RTCPeerConnectionIceEvent - -## Table of contents +*** -### Properties +[werift](../globals.md) / RTCPeerConnectionIceEvent -- [candidate](RTCPeerConnectionIceEvent.md#candidate) +# Interface: RTCPeerConnectionIceEvent ## Properties -### candidate +### candidate? -• **candidate**: [`RTCIceCandidate`](../classes/RTCIceCandidate.md) +> `optional` **candidate**: [`RTCIceCandidate`](../classes/RTCIceCandidate.md) diff --git a/doc/interfaces/RTCRtpParameters.md b/doc/interfaces/RTCRtpParameters.md index 9074c22a2..e4581ceaa 100644 --- a/doc/interfaces/RTCRtpParameters.md +++ b/doc/interfaces/RTCRtpParameters.md @@ -1,56 +1,47 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpParameters +[**werift**](../README.md) • **Docs** -# Interface: RTCRtpParameters - -## Hierarchy +*** -- **`RTCRtpParameters`** +[werift](../globals.md) / RTCRtpParameters - ↳ [`RTCRtpReceiveParameters`](RTCRtpReceiveParameters.md) - -## Table of contents +# Interface: RTCRtpParameters -### Properties +## Extended by -- [codecs](RTCRtpParameters.md#codecs) -- [headerExtensions](RTCRtpParameters.md#headerextensions) -- [muxId](RTCRtpParameters.md#muxid) -- [repairedRtpStreamId](RTCRtpParameters.md#repairedrtpstreamid) -- [rtcp](RTCRtpParameters.md#rtcp) -- [rtpStreamId](RTCRtpParameters.md#rtpstreamid) +- [`RTCRtpReceiveParameters`](RTCRtpReceiveParameters.md) ## Properties ### codecs -• **codecs**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] +> **codecs**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] -___ +*** ### headerExtensions -• **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] +> **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] -___ +*** -### muxId +### muxId? -• `Optional` **muxId**: `string` +> `optional` **muxId**: `string` -___ +*** -### repairedRtpStreamId +### repairedRtpStreamId? -• `Optional` **repairedRtpStreamId**: `string` +> `optional` **repairedRtpStreamId**: `string` -___ +*** -### rtcp +### rtcp? -• `Optional` **rtcp**: [`RTCRtcpParameters`](../classes/RTCRtcpParameters.md) +> `optional` **rtcp**: [`RTCRtcpParameters`](../classes/RTCRtcpParameters.md) -___ +*** -### rtpStreamId +### rtpStreamId? -• `Optional` **rtpStreamId**: `string` +> `optional` **rtpStreamId**: `string` diff --git a/doc/interfaces/RTCRtpReceiveParameters.md b/doc/interfaces/RTCRtpReceiveParameters.md index 3238d6602..23abd91ea 100644 --- a/doc/interfaces/RTCRtpReceiveParameters.md +++ b/doc/interfaces/RTCRtpReceiveParameters.md @@ -1,87 +1,77 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCRtpReceiveParameters +[**werift**](../README.md) • **Docs** -# Interface: RTCRtpReceiveParameters - -## Hierarchy - -- [`RTCRtpParameters`](RTCRtpParameters.md) +*** - ↳ **`RTCRtpReceiveParameters`** +[werift](../globals.md) / RTCRtpReceiveParameters -## Table of contents +# Interface: RTCRtpReceiveParameters -### Properties +## Extends -- [codecs](RTCRtpReceiveParameters.md#codecs) -- [encodings](RTCRtpReceiveParameters.md#encodings) -- [headerExtensions](RTCRtpReceiveParameters.md#headerextensions) -- [muxId](RTCRtpReceiveParameters.md#muxid) -- [repairedRtpStreamId](RTCRtpReceiveParameters.md#repairedrtpstreamid) -- [rtcp](RTCRtpReceiveParameters.md#rtcp) -- [rtpStreamId](RTCRtpReceiveParameters.md#rtpstreamid) +- [`RTCRtpParameters`](RTCRtpParameters.md) ## Properties ### codecs -• **codecs**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] +> **codecs**: [`RTCRtpCodecParameters`](../classes/RTCRtpCodecParameters.md)[] #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[codecs](RTCRtpParameters.md#codecs) +[`RTCRtpParameters`](RTCRtpParameters.md).[`codecs`](RTCRtpParameters.md#codecs) -___ +*** ### encodings -• **encodings**: [`RTCRtpCodingParameters`](../classes/RTCRtpCodingParameters.md)[] +> **encodings**: [`RTCRtpCodingParameters`](../classes/RTCRtpCodingParameters.md)[] -___ +*** ### headerExtensions -• **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] +> **headerExtensions**: [`RTCRtpHeaderExtensionParameters`](../classes/RTCRtpHeaderExtensionParameters.md)[] #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[headerExtensions](RTCRtpParameters.md#headerextensions) +[`RTCRtpParameters`](RTCRtpParameters.md).[`headerExtensions`](RTCRtpParameters.md#headerextensions) -___ +*** -### muxId +### muxId? -• `Optional` **muxId**: `string` +> `optional` **muxId**: `string` #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[muxId](RTCRtpParameters.md#muxid) +[`RTCRtpParameters`](RTCRtpParameters.md).[`muxId`](RTCRtpParameters.md#muxid) -___ +*** -### repairedRtpStreamId +### repairedRtpStreamId? -• `Optional` **repairedRtpStreamId**: `string` +> `optional` **repairedRtpStreamId**: `string` #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[repairedRtpStreamId](RTCRtpParameters.md#repairedrtpstreamid) +[`RTCRtpParameters`](RTCRtpParameters.md).[`repairedRtpStreamId`](RTCRtpParameters.md#repairedrtpstreamid) -___ +*** -### rtcp +### rtcp? -• `Optional` **rtcp**: [`RTCRtcpParameters`](../classes/RTCRtcpParameters.md) +> `optional` **rtcp**: [`RTCRtcpParameters`](../classes/RTCRtcpParameters.md) #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[rtcp](RTCRtpParameters.md#rtcp) +[`RTCRtpParameters`](RTCRtpParameters.md).[`rtcp`](RTCRtpParameters.md#rtcp) -___ +*** -### rtpStreamId +### rtpStreamId? -• `Optional` **rtpStreamId**: `string` +> `optional` **rtpStreamId**: `string` #### Inherited from -[RTCRtpParameters](RTCRtpParameters.md).[rtpStreamId](RTCRtpParameters.md#rtpstreamid) +[`RTCRtpParameters`](RTCRtpParameters.md).[`rtpStreamId`](RTCRtpParameters.md#rtpstreamid) diff --git a/doc/interfaces/RTCSessionDescriptionInit.md b/doc/interfaces/RTCSessionDescriptionInit.md index 59812bfa1..dae820a7a 100644 --- a/doc/interfaces/RTCSessionDescriptionInit.md +++ b/doc/interfaces/RTCSessionDescriptionInit.md @@ -1,22 +1,19 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCSessionDescriptionInit +[**werift**](../README.md) • **Docs** -# Interface: RTCSessionDescriptionInit - -## Table of contents +*** -### Properties +[werift](../globals.md) / RTCSessionDescriptionInit -- [sdp](RTCSessionDescriptionInit.md#sdp) -- [type](RTCSessionDescriptionInit.md#type) +# Interface: RTCSessionDescriptionInit ## Properties -### sdp +### sdp? -• `Optional` **sdp**: `string` +> `optional` **sdp**: `string` -___ +*** ### type -• **type**: [`RTCSdpType`](../modules.md#rtcsdptype) +> **type**: [`RTCSdpType`](../type-aliases/RTCSdpType.md) diff --git a/doc/interfaces/RTCTrackEvent.md b/doc/interfaces/RTCTrackEvent.md index 0efd963ee..7ea481429 100644 --- a/doc/interfaces/RTCTrackEvent.md +++ b/doc/interfaces/RTCTrackEvent.md @@ -1,36 +1,31 @@ -[werift](../README.md) / [Exports](../modules.md) / RTCTrackEvent +[**werift**](../README.md) • **Docs** -# Interface: RTCTrackEvent - -## Table of contents +*** -### Properties +[werift](../globals.md) / RTCTrackEvent -- [receiver](RTCTrackEvent.md#receiver) -- [streams](RTCTrackEvent.md#streams) -- [track](RTCTrackEvent.md#track) -- [transceiver](RTCTrackEvent.md#transceiver) +# Interface: RTCTrackEvent ## Properties ### receiver -• **receiver**: [`RTCRtpReceiver`](../classes/RTCRtpReceiver.md) +> **receiver**: [`RTCRtpReceiver`](../classes/RTCRtpReceiver.md) -___ +*** ### streams -• **streams**: [`MediaStream`](../classes/MediaStream.md)[] +> **streams**: [`MediaStream`](../classes/MediaStream.md)[] -___ +*** ### track -• **track**: [`MediaStreamTrack`](../classes/MediaStreamTrack.md) +> **track**: [`MediaStreamTrack`](../classes/MediaStreamTrack.md) -___ +*** ### transceiver -• **transceiver**: [`RTCRtpTransceiver`](../classes/RTCRtpTransceiver.md) +> **transceiver**: [`RTCRtpTransceiver`](../classes/RTCRtpTransceiver.md) diff --git a/doc/interfaces/TransceiverOptions.md b/doc/interfaces/TransceiverOptions.md index 66e9ca6fe..abf50894a 100644 --- a/doc/interfaces/TransceiverOptions.md +++ b/doc/interfaces/TransceiverOptions.md @@ -1,22 +1,19 @@ -[werift](../README.md) / [Exports](../modules.md) / TransceiverOptions +[**werift**](../README.md) • **Docs** -# Interface: TransceiverOptions - -## Table of contents +*** -### Properties +[werift](../globals.md) / TransceiverOptions -- [direction](TransceiverOptions.md#direction) -- [simulcast](TransceiverOptions.md#simulcast) +# Interface: TransceiverOptions ## Properties ### direction -• **direction**: ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` +> **direction**: `"inactive"` \| `"sendonly"` \| `"recvonly"` \| `"sendrecv"` -___ +*** ### simulcast -• **simulcast**: \{ `direction`: `SimulcastDirection` ; `rid`: `string` }[] +> **simulcast**: `object`[] diff --git a/doc/interfaces/Transport.md b/doc/interfaces/Transport.md new file mode 100644 index 000000000..ba9573ea7 --- /dev/null +++ b/doc/interfaces/Transport.md @@ -0,0 +1,55 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Transport + +# Interface: Transport + +## Properties + +### close() + +> **close**: () => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +*** + +### send() + +> **send**: (`data`, `addr`) => `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### type + +> **type**: `string` diff --git a/doc/interfaces/TurnClientConfig.md b/doc/interfaces/TurnClientConfig.md new file mode 100644 index 000000000..443c708ed --- /dev/null +++ b/doc/interfaces/TurnClientConfig.md @@ -0,0 +1,25 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / TurnClientConfig + +# Interface: TurnClientConfig + +## Properties + +### address + +> **address**: readonly [`string`, `number`] + +*** + +### password + +> **password**: `string` + +*** + +### username + +> **username**: `string` diff --git a/doc/interfaces/TurnClientOptions.md b/doc/interfaces/TurnClientOptions.md new file mode 100644 index 000000000..2d9bac28f --- /dev/null +++ b/doc/interfaces/TurnClientOptions.md @@ -0,0 +1,37 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / TurnClientOptions + +# Interface: TurnClientOptions + +## Properties + +### interfaceAddresses? + +> `optional` **interfaceAddresses**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +*** + +### lifetime? + +> `optional` **lifetime**: `number` + +*** + +### portRange? + +> `optional` **portRange**: [`number`, `number`] + +*** + +### ssl? + +> `optional` **ssl**: `boolean` + +*** + +### transport? + +> `optional` **transport**: `"tcp"` \| `"udp"` diff --git a/doc/modules.md b/doc/modules.md deleted file mode 100644 index 47c5275fd..000000000 --- a/doc/modules.md +++ /dev/null @@ -1,2255 +0,0 @@ -[werift](README.md) / Exports - -# werift - -## Table of contents - -### Enumerations - -- [CandidatePairState](enums/CandidatePairState.md) -- [PacketChunk](enums/PacketChunk.md) -- [PacketStatus](enums/PacketStatus.md) - -### Classes - -- [AV1Obu](classes/AV1Obu.md) -- [AV1RtpPayload](classes/AV1RtpPayload.md) -- [BitStream](classes/BitStream.md) -- [BitWriter](classes/BitWriter.md) -- [BitWriter2](classes/BitWriter2.md) -- [BufferChain](classes/BufferChain.md) -- [Candidate](classes/Candidate.md) -- [CandidatePair](classes/CandidatePair.md) -- [Connection](classes/Connection.md) -- [DePacketizerBase](classes/DePacketizerBase.md) -- [GenericNack](classes/GenericNack.md) -- [GroupDescription](classes/GroupDescription.md) -- [H264RtpPayload](classes/H264RtpPayload.md) -- [IceCandidate](classes/IceCandidate.md) -- [MediaDescription](classes/MediaDescription.md) -- [MediaStream](classes/MediaStream.md) -- [MediaStreamTrack](classes/MediaStreamTrack.md) -- [MediaStreamTrackFactory](classes/MediaStreamTrackFactory.md) -- [OpusRtpPayload](classes/OpusRtpPayload.md) -- [PacketResult](classes/PacketResult.md) -- [PictureLossIndication](classes/PictureLossIndication.md) -- [PromiseQueue](classes/PromiseQueue.md) -- [RTCCertificate](classes/RTCCertificate.md) -- [RTCDataChannel](classes/RTCDataChannel.md) -- [RTCDataChannelParameters](classes/RTCDataChannelParameters.md) -- [RTCDtlsFingerprint](classes/RTCDtlsFingerprint.md) -- [RTCDtlsParameters](classes/RTCDtlsParameters.md) -- [RTCDtlsTransport](classes/RTCDtlsTransport.md) -- [RTCIceCandidate](classes/RTCIceCandidate.md) -- [RTCIceGatherer](classes/RTCIceGatherer.md) -- [RTCIceParameters](classes/RTCIceParameters.md) -- [RTCIceTransport](classes/RTCIceTransport.md) -- [RTCPeerConnection](classes/RTCPeerConnection.md) -- [RTCRtcpFeedback](classes/RTCRtcpFeedback.md) -- [RTCRtcpParameters](classes/RTCRtcpParameters.md) -- [RTCRtpCodecParameters](classes/RTCRtpCodecParameters.md) -- [RTCRtpCodingParameters](classes/RTCRtpCodingParameters.md) -- [RTCRtpHeaderExtensionParameters](classes/RTCRtpHeaderExtensionParameters.md) -- [RTCRtpReceiver](classes/RTCRtpReceiver.md) -- [RTCRtpRtxParameters](classes/RTCRtpRtxParameters.md) -- [RTCRtpSender](classes/RTCRtpSender.md) -- [RTCRtpSimulcastParameters](classes/RTCRtpSimulcastParameters.md) -- [RTCRtpTransceiver](classes/RTCRtpTransceiver.md) -- [RTCSctpCapabilities](classes/RTCSctpCapabilities.md) -- [RTCSctpTransport](classes/RTCSctpTransport.md) -- [RTCSessionDescription](classes/RTCSessionDescription.md) -- [ReceiverEstimatedMaxBitrate](classes/ReceiverEstimatedMaxBitrate.md) -- [RecvDelta](classes/RecvDelta.md) -- [Red](classes/Red.md) -- [RedEncoder](classes/RedEncoder.md) -- [RedHandler](classes/RedHandler.md) -- [RedHeader](classes/RedHeader.md) -- [RtcpHeader](classes/RtcpHeader.md) -- [RtcpPacketConverter](classes/RtcpPacketConverter.md) -- [RtcpPayloadSpecificFeedback](classes/RtcpPayloadSpecificFeedback.md) -- [RtcpReceiverInfo](classes/RtcpReceiverInfo.md) -- [RtcpRrPacket](classes/RtcpRrPacket.md) -- [RtcpSenderInfo](classes/RtcpSenderInfo.md) -- [RtcpSourceDescriptionPacket](classes/RtcpSourceDescriptionPacket.md) -- [RtcpSrPacket](classes/RtcpSrPacket.md) -- [RtcpTransportLayerFeedback](classes/RtcpTransportLayerFeedback.md) -- [RtpBuilder](classes/RtpBuilder.md) -- [RtpHeader](classes/RtpHeader.md) -- [RtpPacket](classes/RtpPacket.md) -- [RunLengthChunk](classes/RunLengthChunk.md) -- [SessionDescription](classes/SessionDescription.md) -- [SourceDescriptionChunk](classes/SourceDescriptionChunk.md) -- [SourceDescriptionItem](classes/SourceDescriptionItem.md) -- [SrtcpSession](classes/SrtcpSession.md) -- [SrtpSession](classes/SrtpSession.md) -- [SsrcDescription](classes/SsrcDescription.md) -- [StatusVectorChunk](classes/StatusVectorChunk.md) -- [TransportWideCC](classes/TransportWideCC.md) -- [Vp8RtpPayload](classes/Vp8RtpPayload.md) -- [Vp9RtpPayload](classes/Vp9RtpPayload.md) -- [WeriftError](classes/WeriftError.md) - -### Interfaces - -- [IceOptions](interfaces/IceOptions.md) -- [MessageEvent](interfaces/MessageEvent.md) -- [PeerConfig](interfaces/PeerConfig.md) -- [Protocol](interfaces/Protocol.md) -- [RTCDataChannelEvent](interfaces/RTCDataChannelEvent.md) -- [RTCErrorEvent](interfaces/RTCErrorEvent.md) -- [RTCPeerConnectionIceEvent](interfaces/RTCPeerConnectionIceEvent.md) -- [RTCRtpParameters](interfaces/RTCRtpParameters.md) -- [RTCRtpReceiveParameters](interfaces/RTCRtpReceiveParameters.md) -- [RTCSessionDescriptionInit](interfaces/RTCSessionDescriptionInit.md) -- [RTCTrackEvent](interfaces/RTCTrackEvent.md) -- [TransceiverOptions](interfaces/TransceiverOptions.md) - -### Type Aliases - -- [Address](modules.md#address) -- [AudioLevelIndicationPayload](modules.md#audiolevelindicationpayload) -- [BundlePolicy](modules.md#bundlepolicy) -- [CipherSuites](modules.md#ciphersuites) -- [ConnectionState](modules.md#connectionstate) -- [CurveTypes](modules.md#curvetypes) -- [DCState](modules.md#dcstate) -- [DepacketizerCodec](modules.md#depacketizercodec) -- [Direction](modules.md#direction) -- [DtlsKeys](modules.md#dtlskeys) -- [DtlsRole](modules.md#dtlsrole) -- [DtlsState](modules.md#dtlsstate) -- [Extension](modules.md#extension) -- [HashAlgorithms](modules.md#hashalgorithms) -- [IceGathererState](modules.md#icegathererstate) -- [InterfaceAddresses](modules.md#interfaceaddresses) -- [Kind](modules.md#kind) -- [NamedCurveAlgorithms](modules.md#namedcurvealgorithms) -- [RTCIceConnectionState](modules.md#rtciceconnectionstate) -- [RTCIceServer](modules.md#rtciceserver) -- [RTCPFB](modules.md#rtcpfb) -- [RTCRtpSendParameters](modules.md#rtcrtpsendparameters) -- [RTCSdpType](modules.md#rtcsdptype) -- [RTCSignalingState](modules.md#rtcsignalingstate) -- [RequireAtLeastOne](modules.md#requireatleastone) -- [RtcpPacket](modules.md#rtcppacket) -- [SignatureAlgorithms](modules.md#signaturealgorithms) -- [SignatureHash](modules.md#signaturehash) -- [SignatureSchemes](modules.md#signatureschemes) -- [TransportWideCCPayload](modules.md#transportwideccpayload) - -### Variables - -- [CipherSuite](modules.md#ciphersuite) -- [CipherSuiteList](modules.md#ciphersuitelist) -- [ConnectionStates](modules.md#connectionstates) -- [CurveType](modules.md#curvetype) -- [Directions](modules.md#directions) -- [DtlsStates](modules.md#dtlsstates) -- [ExtensionProfiles](modules.md#extensionprofiles) -- [HashAlgorithm](modules.md#hashalgorithm) -- [IceGathererStates](modules.md#icegathererstates) -- [IceTransportStates](modules.md#icetransportstates) -- [Inactive](modules.md#inactive) -- [NalUnitType](modules.md#nalunittype) -- [NamedCurveAlgorithm](modules.md#namedcurvealgorithm) -- [NamedCurveAlgorithmList](modules.md#namedcurvealgorithmlist) -- [RTCP\_HEADER\_SIZE](modules.md#rtcp_header_size) -- [RTP\_EXTENSION\_URI](modules.md#rtp_extension_uri) -- [Recvonly](modules.md#recvonly) -- [Sendonly](modules.md#sendonly) -- [Sendrecv](modules.md#sendrecv) -- [SignalingStates](modules.md#signalingstates) -- [SignatureAlgorithm](modules.md#signaturealgorithm) -- [SignatureScheme](modules.md#signaturescheme) -- [certificateTypes](modules.md#certificatetypes) -- [defaultPeerConfig](modules.md#defaultpeerconfig) -- [depacketizerCodecs](modules.md#depacketizercodecs) -- [signatures](modules.md#signatures) -- [timer](modules.md#timer) - -### Functions - -- [Int](modules.md#int) -- [addSDPHeader](modules.md#addsdpheader) -- [addTransportDescription](modules.md#addtransportdescription) -- [allocateMid](modules.md#allocatemid) -- [andDirection](modules.md#anddirection) -- [buffer2ArrayBuffer](modules.md#buffer2arraybuffer) -- [bufferArrayXor](modules.md#bufferarrayxor) -- [bufferReader](modules.md#bufferreader) -- [bufferWriter](modules.md#bufferwriter) -- [bufferWriterLE](modules.md#bufferwriterle) -- [bufferXor](modules.md#bufferxor) -- [candidateFoundation](modules.md#candidatefoundation) -- [candidateFromIce](modules.md#candidatefromice) -- [candidateFromSdp](modules.md#candidatefromsdp) -- [candidatePairPriority](modules.md#candidatepairpriority) -- [candidatePriority](modules.md#candidatepriority) -- [candidateToIce](modules.md#candidatetoice) -- [candidateToSdp](modules.md#candidatetosdp) -- [codecParametersFromString](modules.md#codecparametersfromstring) -- [codecParametersToString](modules.md#codecparameterstostring) -- [compactNtp](modules.md#compactntp) -- [createBufferWriter](modules.md#createbufferwriter) -- [createMediaDescriptionForSctp](modules.md#createmediadescriptionforsctp) -- [createMediaDescriptionForTransceiver](modules.md#createmediadescriptionfortransceiver) -- [createSelfSignedCertificate](modules.md#createselfsignedcertificate) -- [dePacketizeRtpPackets](modules.md#depacketizertppackets) -- [deepMerge](modules.md#deepmerge) -- [deserializeAbsSendTime](modules.md#deserializeabssendtime) -- [deserializeAudioLevelIndication](modules.md#deserializeaudiolevelindication) -- [deserializeString](modules.md#deserializestring) -- [deserializeUint16BE](modules.md#deserializeuint16be) -- [dumpBuffer](modules.md#dumpbuffer) -- [enumerate](modules.md#enumerate) -- [findCodecByMimeType](modules.md#findcodecbymimetype) -- [findPort](modules.md#findport) -- [fingerprint](modules.md#fingerprint) -- [getBit](modules.md#getbit) -- [getGlobalIp](modules.md#getglobalip) -- [getHostAddresses](modules.md#gethostaddresses) -- [growBufferSize](modules.md#growbuffersize) -- [int](modules.md#int-1) -- [interfaceAddress](modules.md#interfaceaddress) -- [isDtls](modules.md#isdtls) -- [isMedia](modules.md#ismedia) -- [isRtcp](modules.md#isrtcp) -- [leb128decode](modules.md#leb128decode) -- [microTime](modules.md#microtime) -- [milliTime](modules.md#millitime) -- [normalizeFamilyNodeV18](modules.md#normalizefamilynodev18) -- [ntpTime](modules.md#ntptime) -- [ntpTime2Sec](modules.md#ntptime2sec) -- [paddingBits](modules.md#paddingbits) -- [paddingByte](modules.md#paddingbyte) -- [parseGroup](modules.md#parsegroup) -- [parseIceServers](modules.md#parseiceservers) -- [random16](modules.md#random16) -- [random32](modules.md#random32) -- [randomPort](modules.md#randomport) -- [randomPorts](modules.md#randomports) -- [reverseDirection](modules.md#reversedirection) -- [reverseSimulcastDirection](modules.md#reversesimulcastdirection) -- [rtpHeaderExtensionsParser](modules.md#rtpheaderextensionsparser) -- [serializeAbsSendTime](modules.md#serializeabssendtime) -- [serializeAudioLevelIndication](modules.md#serializeaudiolevelindication) -- [serializeRepairedRtpStreamId](modules.md#serializerepairedrtpstreamid) -- [serializeSdesMid](modules.md#serializesdesmid) -- [serializeSdesRTPStreamID](modules.md#serializesdesrtpstreamid) -- [serializeTransportWideCC](modules.md#serializetransportwidecc) -- [serverReflexiveCandidate](modules.md#serverreflexivecandidate) -- [sortCandidatePairs](modules.md#sortcandidatepairs) -- [timestampSeconds](modules.md#timestampseconds) -- [uint16Add](modules.md#uint16add) -- [uint16Gt](modules.md#uint16gt) -- [uint16Gte](modules.md#uint16gte) -- [uint24](modules.md#uint24) -- [uint32Add](modules.md#uint32add) -- [uint32Gt](modules.md#uint32gt) -- [uint32Gte](modules.md#uint32gte) -- [uint8Add](modules.md#uint8add) -- [unwrapRtx](modules.md#unwraprtx) -- [useAbsSendTime](modules.md#useabssendtime) -- [useAudioLevelIndication](modules.md#useaudiolevelindication) -- [useDependencyDescriptor](modules.md#usedependencydescriptor) -- [useFIR](modules.md#usefir) -- [useNACK](modules.md#usenack) -- [usePLI](modules.md#usepli) -- [useREMB](modules.md#useremb) -- [useRepairedRtpStreamId](modules.md#userepairedrtpstreamid) -- [useSdesMid](modules.md#usesdesmid) -- [useSdesRTPStreamId](modules.md#usesdesrtpstreamid) -- [useTWCC](modules.md#usetwcc) -- [useTransportWideCC](modules.md#usetransportwidecc) -- [validateAddress](modules.md#validateaddress) -- [validateRemoteCandidate](modules.md#validateremotecandidate) -- [wrapRtx](modules.md#wraprtx) - -## Type Aliases - -### Address - -Ƭ **Address**: `Readonly`\<[`string`, `number`]\> - -___ - -### AudioLevelIndicationPayload - -Ƭ **AudioLevelIndicationPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `level` | `number` | -| `v` | `boolean` | - -___ - -### BundlePolicy - -Ƭ **BundlePolicy**: ``"max-compat"`` \| ``"max-bundle"`` \| ``"disable"`` - -___ - -### CipherSuites - -Ƭ **CipherSuites**: typeof [`CipherSuite`](modules.md#ciphersuite)[keyof typeof [`CipherSuite`](modules.md#ciphersuite)] - -___ - -### ConnectionState - -Ƭ **ConnectionState**: typeof [`ConnectionStates`](modules.md#connectionstates)[`number`] - -___ - -### CurveTypes - -Ƭ **CurveTypes**: typeof [`CurveType`](modules.md#curvetype)[keyof typeof [`CurveType`](modules.md#curvetype)] - -___ - -### DCState - -Ƭ **DCState**: ``"open"`` \| ``"closed"`` \| ``"connecting"`` \| ``"closing"`` - -___ - -### DepacketizerCodec - -Ƭ **DepacketizerCodec**: typeof [`depacketizerCodecs`](modules.md#depacketizercodecs)[`number`] \| `Lowercase`\ - -___ - -### Direction - -Ƭ **Direction**: typeof [`Directions`](modules.md#directions)[`number`] - -___ - -### DtlsKeys - -Ƭ **DtlsKeys**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `certPem` | `string` | -| `keyPem` | `string` | -| `signatureHash` | [`SignatureHash`](modules.md#signaturehash) | - -___ - -### DtlsRole - -Ƭ **DtlsRole**: ``"auto"`` \| ``"server"`` \| ``"client"`` - -___ - -### DtlsState - -Ƭ **DtlsState**: typeof [`DtlsStates`](modules.md#dtlsstates)[`number`] - -___ - -### Extension - -Ƭ **Extension**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `number` | -| `payload` | `Buffer` | - -___ - -### HashAlgorithms - -Ƭ **HashAlgorithms**: typeof [`HashAlgorithm`](modules.md#hashalgorithm)[keyof typeof [`HashAlgorithm`](modules.md#hashalgorithm)] - -___ - -### IceGathererState - -Ƭ **IceGathererState**: typeof [`IceGathererStates`](modules.md#icegathererstates)[`number`] - -___ - -### InterfaceAddresses - -Ƭ **InterfaceAddresses**: \{ [K in SocketType]?: string } - -___ - -### Kind - -Ƭ **Kind**: ``"audio"`` \| ``"video"`` \| ``"application"`` \| ``"unknown"`` - -___ - -### NamedCurveAlgorithms - -Ƭ **NamedCurveAlgorithms**: typeof [`NamedCurveAlgorithm`](modules.md#namedcurvealgorithm)[keyof typeof [`NamedCurveAlgorithm`](modules.md#namedcurvealgorithm)] - -___ - -### RTCIceConnectionState - -Ƭ **RTCIceConnectionState**: typeof [`IceTransportStates`](modules.md#icetransportstates)[`number`] - -___ - -### RTCIceServer - -Ƭ **RTCIceServer**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `credential?` | `string` | -| `urls` | `string` | -| `username?` | `string` | - -___ - -### RTCPFB - -Ƭ **RTCPFB**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `parameter?` | `string` | -| `type` | `string` | - -___ - -### RTCRtpSendParameters - -Ƭ **RTCRtpSendParameters**: [`RTCRtpParameters`](interfaces/RTCRtpParameters.md) - -___ - -### RTCSdpType - -Ƭ **RTCSdpType**: ``"answer"`` \| ``"offer"`` \| ``"pranswer"`` \| ``"rollback"`` - -___ - -### RTCSignalingState - -Ƭ **RTCSignalingState**: typeof [`SignalingStates`](modules.md#signalingstates)[`number`] - -___ - -### RequireAtLeastOne - -Ƭ **RequireAtLeastOne**\<`T`\>: \{ [K in keyof T]-?: Required\\> & Partial\\>\> }[keyof `T`] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -___ - -### RtcpPacket - -Ƭ **RtcpPacket**: [`RtcpRrPacket`](classes/RtcpRrPacket.md) \| [`RtcpSrPacket`](classes/RtcpSrPacket.md) \| [`RtcpPayloadSpecificFeedback`](classes/RtcpPayloadSpecificFeedback.md) \| [`RtcpSourceDescriptionPacket`](classes/RtcpSourceDescriptionPacket.md) \| [`RtcpTransportLayerFeedback`](classes/RtcpTransportLayerFeedback.md) - -___ - -### SignatureAlgorithms - -Ƭ **SignatureAlgorithms**: typeof [`SignatureAlgorithm`](modules.md#signaturealgorithm)[keyof typeof [`SignatureAlgorithm`](modules.md#signaturealgorithm)] - -___ - -### SignatureHash - -Ƭ **SignatureHash**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `hash` | [`HashAlgorithms`](modules.md#hashalgorithms) | -| `signature` | [`SignatureAlgorithms`](modules.md#signaturealgorithms) | - -___ - -### SignatureSchemes - -Ƭ **SignatureSchemes**: typeof [`SignatureScheme`](modules.md#signaturescheme)[keyof typeof [`SignatureScheme`](modules.md#signaturescheme)] - -___ - -### TransportWideCCPayload - -Ƭ **TransportWideCCPayload**: `number` - -## Variables - -### CipherSuite - -• `Const` **CipherSuite**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256_49195` | ``49195`` | -| `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256_49199` | ``49199`` | - -___ - -### CipherSuiteList - -• `Const` **CipherSuiteList**: [`CipherSuites`](modules.md#ciphersuites)[] - -___ - -### ConnectionStates - -• `Const` **ConnectionStates**: readonly [``"closed"``, ``"failed"``, ``"disconnected"``, ``"new"``, ``"connecting"``, ``"connected"``] - -___ - -### CurveType - -• `Const` **CurveType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `named_curve_3` | ``3`` | - -___ - -### Directions - -• `Const` **Directions**: readonly [``"inactive"``, ``"sendonly"``, ``"recvonly"``, ``"sendrecv"``] - -___ - -### DtlsStates - -• `Const` **DtlsStates**: readonly [``"new"``, ``"connecting"``, ``"connected"``, ``"closed"``, ``"failed"``] - -___ - -### ExtensionProfiles - -• `Const` **ExtensionProfiles**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `OneByte` | ``48862`` | -| `TwoByte` | ``4096`` | - -___ - -### HashAlgorithm - -• `Const` **HashAlgorithm**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `sha256_4` | ``4`` | - -___ - -### IceGathererStates - -• `Const` **IceGathererStates**: readonly [``"new"``, ``"gathering"``, ``"complete"``] - -___ - -### IceTransportStates - -• `Const` **IceTransportStates**: readonly [``"new"``, ``"checking"``, ``"connected"``, ``"completed"``, ``"disconnected"``, ``"failed"``, ``"closed"``] - -___ - -### Inactive - -• `Const` **Inactive**: ``"inactive"`` - -___ - -### NalUnitType - -• `Const` **NalUnitType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fu_a` | ``28`` | -| `fu_b` | ``29`` | -| `idrSlice` | ``5`` | -| `mtap16` | ``26`` | -| `mtap24` | ``27`` | -| `stap_a` | ``24`` | -| `stap_b` | ``25`` | - -___ - -### NamedCurveAlgorithm - -• `Const` **NamedCurveAlgorithm**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `secp256r1_23` | ``23`` | -| `x25519_29` | ``29`` | - -___ - -### NamedCurveAlgorithmList - -• `Const` **NamedCurveAlgorithmList**: [`NamedCurveAlgorithms`](modules.md#namedcurvealgorithms)[] - -___ - -### RTCP\_HEADER\_SIZE - -• `Const` **RTCP\_HEADER\_SIZE**: ``4`` - -___ - -### RTP\_EXTENSION\_URI - -• `Const` **RTP\_EXTENSION\_URI**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `absSendTime` | ``"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"`` | -| `audioLevelIndication` | ``"urn:ietf:params:rtp-hdrext:ssrc-audio-level"`` | -| `dependencyDescriptor` | ``"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"`` | -| `repairedRtpStreamId` | ``"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"`` | -| `sdesMid` | ``"urn:ietf:params:rtp-hdrext:sdes:mid"`` | -| `sdesRTPStreamID` | ``"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"`` | -| `transportWideCC` | ``"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"`` | - -___ - -### Recvonly - -• `Const` **Recvonly**: ``"recvonly"`` - -___ - -### Sendonly - -• `Const` **Sendonly**: ``"sendonly"`` - -___ - -### Sendrecv - -• `Const` **Sendrecv**: ``"sendrecv"`` - -___ - -### SignalingStates - -• `Const` **SignalingStates**: readonly [``"stable"``, ``"have-local-offer"``, ``"have-remote-offer"``, ``"have-local-pranswer"``, ``"have-remote-pranswer"``, ``"closed"``] - -___ - -### SignatureAlgorithm - -• `Const` **SignatureAlgorithm**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ecdsa_3` | ``3`` | -| `rsa_1` | ``1`` | - -___ - -### SignatureScheme - -• `Const` **SignatureScheme**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ecdsa_secp256r1_sha256` | ``1027`` | -| `rsa_pkcs1_sha256` | ``1025`` | - -___ - -### certificateTypes - -• `Const` **certificateTypes**: `number`[] - -___ - -### defaultPeerConfig - -• `Const` **defaultPeerConfig**: [`PeerConfig`](interfaces/PeerConfig.md) - -___ - -### depacketizerCodecs - -• `Const` **depacketizerCodecs**: readonly [``"MPEG4/ISO/AVC"``, ``"VP8"``, ``"VP9"``, ``"OPUS"``, ``"AV1"``] - -___ - -### signatures - -• `Const` **signatures**: (\{ `hash`: ``4`` = HashAlgorithm.sha256\_4; `signature`: ``1`` = SignatureAlgorithm.rsa\_1 } \| \{ `hash`: ``4`` = HashAlgorithm.sha256\_4; `signature`: ``3`` = SignatureAlgorithm.ecdsa\_3 })[] - -___ - -### timer - -• `Const` **timer**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `setInterval` | (...`args`: [callback: Function, ms?: number]) => () => `void` | -| `setTimeout` | (...`args`: [callback: Function, ms?: number]) => () => `void` | - -## Functions - -### Int - -▸ **Int**(`v`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | `number` | - -#### Returns - -`number` - -___ - -### addSDPHeader - -▸ **addSDPHeader**(`type`, `description`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | ``"offer"`` \| ``"answer"`` | -| `description` | [`SessionDescription`](classes/SessionDescription.md) | - -#### Returns - -`void` - -___ - -### addTransportDescription - -▸ **addTransportDescription**(`media`, `dtlsTransport`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `media` | [`MediaDescription`](classes/MediaDescription.md) | -| `dtlsTransport` | [`RTCDtlsTransport`](classes/RTCDtlsTransport.md) | - -#### Returns - -`void` - -___ - -### allocateMid - -▸ **allocateMid**(`mids`, `type`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `mids` | `Set`\<`string`\> | -| `type` | ``""`` \| ``"dc"`` \| ``"av"`` | - -#### Returns - -`string` - -___ - -### andDirection - -▸ **andDirection**(`a`, `b`): ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | -| `b` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | - -#### Returns - -``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` - -___ - -### buffer2ArrayBuffer - -▸ **buffer2ArrayBuffer**(`buf`): `ArrayBuffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`ArrayBuffer` - -___ - -### bufferArrayXor - -▸ **bufferArrayXor**(`arr`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `arr` | `Buffer`[] | - -#### Returns - -`Buffer` - -___ - -### bufferReader - -▸ **bufferReader**(`buf`, `bytes`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `bytes` | `number`[] | - -#### Returns - -`any`[] - -___ - -### bufferWriter - -▸ **bufferWriter**(`bytes`, `values`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `values` | (`number` \| `bigint`)[] | - -#### Returns - -`Buffer` - -___ - -### bufferWriterLE - -▸ **bufferWriterLE**(`bytes`, `values`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `values` | (`number` \| `bigint`)[] | - -#### Returns - -`Buffer` - -___ - -### bufferXor - -▸ **bufferXor**(`a`, `b`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `Buffer` | -| `b` | `Buffer` | - -#### Returns - -`Buffer` - -___ - -### candidateFoundation - -▸ **candidateFoundation**(`candidateType`, `candidateTransport`, `baseAddress`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `candidateType` | `string` | -| `candidateTransport` | `string` | -| `baseAddress` | `string` | - -#### Returns - -`string` - -___ - -### candidateFromIce - -▸ **candidateFromIce**(`c`): [`IceCandidate`](classes/IceCandidate.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | [`Candidate`](classes/Candidate.md) | - -#### Returns - -[`IceCandidate`](classes/IceCandidate.md) - -___ - -### candidateFromSdp - -▸ **candidateFromSdp**(`sdp`): [`IceCandidate`](classes/IceCandidate.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sdp` | `string` | - -#### Returns - -[`IceCandidate`](classes/IceCandidate.md) - -___ - -### candidatePairPriority - -▸ **candidatePairPriority**(`local`, `remote`, `iceControlling`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `local` | [`Candidate`](classes/Candidate.md) | -| `remote` | [`Candidate`](classes/Candidate.md) | -| `iceControlling` | `boolean` | - -#### Returns - -`number` - -___ - -### candidatePriority - -▸ **candidatePriority**(`candidateComponent`, `candidateType`, `localPref?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `candidateComponent` | `number` | `undefined` | -| `candidateType` | `string` | `undefined` | -| `localPref` | `number` | `65535` | - -#### Returns - -`number` - -___ - -### candidateToIce - -▸ **candidateToIce**(`x`): [`Candidate`](classes/Candidate.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | [`IceCandidate`](classes/IceCandidate.md) | - -#### Returns - -[`Candidate`](classes/Candidate.md) - -___ - -### candidateToSdp - -▸ **candidateToSdp**(`c`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | [`IceCandidate`](classes/IceCandidate.md) | - -#### Returns - -`string` - -___ - -### codecParametersFromString - -▸ **codecParametersFromString**(`str`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`Object` - -___ - -### codecParametersToString - -▸ **codecParametersToString**(`parameters`, `joint?`): `undefined` \| `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `parameters` | `Object` | `undefined` | -| `joint` | `string` | `"="` | - -#### Returns - -`undefined` \| `string` - -___ - -### compactNtp - -▸ **compactNtp**(`ntp`): `number` - -https://datatracker.ietf.org/doc/html/rfc3550#section-4 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ntp` | `bigint` | - -#### Returns - -`number` - -32bit - -___ - -### createBufferWriter - -▸ **createBufferWriter**(`bytes`, `singleBuffer?`): (`values`: (`number` \| `bigint`)[]) => `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `singleBuffer?` | `boolean` | - -#### Returns - -`fn` - -▸ (`values`): `Buffer` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `values` | (`number` \| `bigint`)[] | - -##### Returns - -`Buffer` - -___ - -### createMediaDescriptionForSctp - -▸ **createMediaDescriptionForSctp**(`sctp`): [`MediaDescription`](classes/MediaDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sctp` | [`RTCSctpTransport`](classes/RTCSctpTransport.md) | - -#### Returns - -[`MediaDescription`](classes/MediaDescription.md) - -___ - -### createMediaDescriptionForTransceiver - -▸ **createMediaDescriptionForTransceiver**(`transceiver`, `cname`, `direction`): [`MediaDescription`](classes/MediaDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transceiver` | [`RTCRtpTransceiver`](classes/RTCRtpTransceiver.md) | -| `cname` | `string` | -| `direction` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | - -#### Returns - -[`MediaDescription`](classes/MediaDescription.md) - -___ - -### createSelfSignedCertificate - -▸ **createSelfSignedCertificate**(`signatureHash`, `namedCurveAlgorithm?`): `Promise`\<\{ `certPem`: `string` ; `keyPem`: `string` ; `signatureHash`: [`SignatureHash`](modules.md#signaturehash) }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `signatureHash` | [`SignatureHash`](modules.md#signaturehash) | | -| `namedCurveAlgorithm?` | ``29`` \| ``23`` | necessary when use ecdsa | - -#### Returns - -`Promise`\<\{ `certPem`: `string` ; `keyPem`: `string` ; `signatureHash`: [`SignatureHash`](modules.md#signaturehash) }\> - -___ - -### dePacketizeRtpPackets - -▸ **dePacketizeRtpPackets**(`codec`, `packets`, `frameFragmentBuffer?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `codec` | [`DepacketizerCodec`](modules.md#depacketizercodec) | -| `packets` | [`RtpPacket`](classes/RtpPacket.md)[] | -| `frameFragmentBuffer?` | `Buffer` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `frameFragmentBuffer?` | `Buffer` | -| `isKeyframe` | `boolean` | -| `sequence` | `number` | -| `timestamp` | `number` | - -___ - -### deepMerge - -▸ **deepMerge**\<`T`\>(`dst`, `src`): `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dst` | `T` | -| `src` | `T` | - -#### Returns - -`T` - -___ - -### deserializeAbsSendTime - -▸ **deserializeAbsSendTime**(`buf`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`any` - -___ - -### deserializeAudioLevelIndication - -▸ **deserializeAudioLevelIndication**(`buf`): [`AudioLevelIndicationPayload`](modules.md#audiolevelindicationpayload) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -[`AudioLevelIndicationPayload`](modules.md#audiolevelindicationpayload) - -___ - -### deserializeString - -▸ **deserializeString**(`buf`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`string` - -___ - -### deserializeUint16BE - -▸ **deserializeUint16BE**(`buf`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`number` - -___ - -### dumpBuffer - -▸ **dumpBuffer**(`data`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | - -#### Returns - -`string` - -___ - -### enumerate - -▸ **enumerate**\<`T`\>(`arr`): [`number`, `T`][] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `arr` | `T`[] | - -#### Returns - -[`number`, `T`][] - -___ - -### findCodecByMimeType - -▸ **findCodecByMimeType**(`codecs`, `target`): `undefined` \| [`RTCRtpCodecParameters`](classes/RTCRtpCodecParameters.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `codecs` | [`RTCRtpCodecParameters`](classes/RTCRtpCodecParameters.md)[] | -| `target` | [`RTCRtpCodecParameters`](classes/RTCRtpCodecParameters.md) | - -#### Returns - -`undefined` \| [`RTCRtpCodecParameters`](classes/RTCRtpCodecParameters.md) - -___ - -### findPort - -▸ **findPort**(`min`, `max`, `protocol?`, `interfaceAddresses?`): `Promise`\<`number`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `min` | `number` | `undefined` | -| `max` | `number` | `undefined` | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`\> - -___ - -### fingerprint - -▸ **fingerprint**(`file`, `hashName`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | `Buffer` | -| `hashName` | `string` | - -#### Returns - -`any` - -___ - -### getBit - -▸ **getBit**(`bits`, `startIndex`, `length?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `bits` | `number` | `undefined` | -| `startIndex` | `number` | `undefined` | -| `length` | `number` | `1` | - -#### Returns - -`number` - -___ - -### getGlobalIp - -▸ **getGlobalIp**(`stunServer?`, `interfaceAddresses?`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stunServer?` | readonly [`string`, `number`] | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | - -#### Returns - -`Promise`\<`string`\> - -___ - -### getHostAddresses - -▸ **getHostAddresses**(`useIpv4`, `useIpv6`): `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `useIpv4` | `boolean` | -| `useIpv6` | `boolean` | - -#### Returns - -`string`[] - -___ - -### growBufferSize - -▸ **growBufferSize**(`buf`, `size`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `size` | `number` | - -#### Returns - -`Buffer` - -___ - -### int - -▸ **int**(`n`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -`number` - -___ - -### interfaceAddress - -▸ **interfaceAddress**(`type`, `interfaceAddresses`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `SocketType` | -| `interfaceAddresses` | `undefined` \| [`InterfaceAddresses`](modules.md#interfaceaddresses) | - -#### Returns - -`undefined` \| `string` - -___ - -### isDtls - -▸ **isDtls**(`buf`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`boolean` - -___ - -### isMedia - -▸ **isMedia**(`buf`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`boolean` - -___ - -### isRtcp - -▸ **isRtcp**(`buf`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`boolean` - -___ - -### leb128decode - -▸ **leb128decode**(`buf`): `number`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`number`[] - -___ - -### microTime - -▸ **microTime**(): `number` - -#### Returns - -`number` - -___ - -### milliTime - -▸ **milliTime**(): `number` - -#### Returns - -`number` - -___ - -### normalizeFamilyNodeV18 - -▸ **normalizeFamilyNodeV18**(`family`): ``4`` \| ``6`` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `family` | `string` \| `number` | - -#### Returns - -``4`` \| ``6`` - -___ - -### ntpTime - -▸ **ntpTime**(): `bigint` - -https://datatracker.ietf.org/doc/html/rfc3550#section-4 - -#### Returns - -`bigint` - -___ - -### ntpTime2Sec - -▸ **ntpTime2Sec**(`ntp`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ntp` | `bigint` | - -#### Returns - -`number` - -___ - -### paddingBits - -▸ **paddingBits**(`bits`, `expectLength`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `expectLength` | `number` | - -#### Returns - -`string` - -___ - -### paddingByte - -▸ **paddingByte**(`bits`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bits` | `number` | - -#### Returns - -`string` - -___ - -### parseGroup - -▸ **parseGroup**(`dest`, `value`, `type?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dest` | [`GroupDescription`](classes/GroupDescription.md)[] | -| `value` | `string` | -| `type` | (`v`: `string`) => `any` | - -#### Returns - -`void` - -___ - -### parseIceServers - -▸ **parseIceServers**(`iceServers`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iceServers` | [`RTCIceServer`](modules.md#rtciceserver)[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `stunServer` | `undefined` \| readonly [`string`, `number`] | -| `turnPassword` | `undefined` \| `string` | -| `turnServer` | `undefined` \| readonly [`string`, `number`] | -| `turnUsername` | `undefined` \| `string` | - -___ - -### random16 - -▸ **random16**(): `number` - -#### Returns - -`number` - -___ - -### random32 - -▸ **random32**(): `number` - -#### Returns - -`number` - -___ - -### randomPort - -▸ **randomPort**(`protocol?`, `interfaceAddresses?`): `Promise`\<`number`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`\> - -___ - -### randomPorts - -▸ **randomPorts**(`num`, `protocol?`, `interfaceAddresses?`): `Promise`\<`number`[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `num` | `number` | `undefined` | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`[]\> - -___ - -### reverseDirection - -▸ **reverseDirection**(`dir`): [`Direction`](modules.md#direction) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dir` | ``"inactive"`` \| ``"sendonly"`` \| ``"recvonly"`` \| ``"sendrecv"`` | - -#### Returns - -[`Direction`](modules.md#direction) - -___ - -### reverseSimulcastDirection - -▸ **reverseSimulcastDirection**(`dir`): ``"send"`` \| ``"recv"`` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dir` | ``"send"`` \| ``"recv"`` | - -#### Returns - -``"send"`` \| ``"recv"`` - -___ - -### rtpHeaderExtensionsParser - -▸ **rtpHeaderExtensionsParser**(`extensions`, `extIdUriMap`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extensions` | [`Extension`](modules.md#extension)[] | -| `extIdUriMap` | `Object` | - -#### Returns - -`Object` - -___ - -### serializeAbsSendTime - -▸ **serializeAbsSendTime**(`ntpTime`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ntpTime` | `bigint` | - -#### Returns - -`Buffer` - -___ - -### serializeAudioLevelIndication - -▸ **serializeAudioLevelIndication**(`level`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `level` | `number` | - -#### Returns - -`Buffer` - -___ - -### serializeRepairedRtpStreamId - -▸ **serializeRepairedRtpStreamId**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeSdesMid - -▸ **serializeSdesMid**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeSdesRTPStreamID - -▸ **serializeSdesRTPStreamID**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeTransportWideCC - -▸ **serializeTransportWideCC**(`transportSequenceNumber`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transportSequenceNumber` | `number` | - -#### Returns - -`Buffer` - -___ - -### serverReflexiveCandidate - -▸ **serverReflexiveCandidate**(`protocol`, `stunServer`): `Promise`\<`undefined` \| [`Candidate`](classes/Candidate.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `protocol` | [`Protocol`](interfaces/Protocol.md) | -| `stunServer` | readonly [`string`, `number`] | - -#### Returns - -`Promise`\<`undefined` \| [`Candidate`](classes/Candidate.md)\> - -___ - -### sortCandidatePairs - -▸ **sortCandidatePairs**(`pairs`, `iceControlling`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pairs` | [`CandidatePair`](classes/CandidatePair.md)[] | -| `iceControlling` | `boolean` | - -#### Returns - -`void` - -___ - -### timestampSeconds - -▸ **timestampSeconds**(): `number` - -#### Returns - -`number` - -___ - -### uint16Add - -▸ **uint16Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### uint16Gt - -▸ **uint16Gt**(`a`, `b`): `boolean` - -Return a > b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint16Gte - -▸ **uint16Gte**(`a`, `b`): `boolean` - -Return a >= b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint24 - -▸ **uint24**(`v`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | `number` | - -#### Returns - -`number` - -___ - -### uint32Add - -▸ **uint32Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### uint32Gt - -▸ **uint32Gt**(`a`, `b`): `boolean` - -Return a > b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint32Gte - -▸ **uint32Gte**(`a`, `b`): `boolean` - -Return a >= b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint8Add - -▸ **uint8Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### unwrapRtx - -▸ **unwrapRtx**(`rtx`, `payloadType`, `ssrc`): [`RtpPacket`](classes/RtpPacket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `rtx` | [`RtpPacket`](classes/RtpPacket.md) | -| `payloadType` | `number` | -| `ssrc` | `number` | - -#### Returns - -[`RtpPacket`](classes/RtpPacket.md) - -___ - -### useAbsSendTime - -▸ **useAbsSendTime**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useAudioLevelIndication - -▸ **useAudioLevelIndication**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useDependencyDescriptor - -▸ **useDependencyDescriptor**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useFIR - -▸ **useFIR**(): [`RTCPFB`](modules.md#rtcpfb) - -#### Returns - -[`RTCPFB`](modules.md#rtcpfb) - -___ - -### useNACK - -▸ **useNACK**(): [`RTCPFB`](modules.md#rtcpfb) - -#### Returns - -[`RTCPFB`](modules.md#rtcpfb) - -___ - -### usePLI - -▸ **usePLI**(): [`RTCPFB`](modules.md#rtcpfb) - -#### Returns - -[`RTCPFB`](modules.md#rtcpfb) - -___ - -### useREMB - -▸ **useREMB**(): [`RTCPFB`](modules.md#rtcpfb) - -#### Returns - -[`RTCPFB`](modules.md#rtcpfb) - -___ - -### useRepairedRtpStreamId - -▸ **useRepairedRtpStreamId**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useSdesMid - -▸ **useSdesMid**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useSdesRTPStreamId - -▸ **useSdesRTPStreamId**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### useTWCC - -▸ **useTWCC**(): [`RTCPFB`](modules.md#rtcpfb) - -#### Returns - -[`RTCPFB`](modules.md#rtcpfb) - -___ - -### useTransportWideCC - -▸ **useTransportWideCC**(): [`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -#### Returns - -[`RTCRtpHeaderExtensionParameters`](classes/RTCRtpHeaderExtensionParameters.md) - -___ - -### validateAddress - -▸ **validateAddress**(`addr?`): [`Address`](modules.md#address) \| `undefined` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addr?` | readonly [`string`, `number`] | - -#### Returns - -[`Address`](modules.md#address) \| `undefined` - -___ - -### validateRemoteCandidate - -▸ **validateRemoteCandidate**(`candidate`): [`Candidate`](classes/Candidate.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `candidate` | [`Candidate`](classes/Candidate.md) | - -#### Returns - -[`Candidate`](classes/Candidate.md) - -___ - -### wrapRtx - -▸ **wrapRtx**(`packet`, `payloadType`, `sequenceNumber`, `ssrc`): [`RtpPacket`](classes/RtpPacket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `packet` | [`RtpPacket`](classes/RtpPacket.md) | -| `payloadType` | `number` | -| `sequenceNumber` | `number` | -| `ssrc` | `number` | - -#### Returns - -[`RtpPacket`](classes/RtpPacket.md) diff --git a/doc/type-aliases/Address.md b/doc/type-aliases/Address.md new file mode 100644 index 000000000..91acac028 --- /dev/null +++ b/doc/type-aliases/Address.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Address + +# Type Alias: Address + +> **Address**: `Readonly`\<[`string`, `number`]\> diff --git a/doc/type-aliases/AudioLevelIndicationPayload.md b/doc/type-aliases/AudioLevelIndicationPayload.md new file mode 100644 index 000000000..5c09615fe --- /dev/null +++ b/doc/type-aliases/AudioLevelIndicationPayload.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / AudioLevelIndicationPayload + +# Type Alias: AudioLevelIndicationPayload + +> **AudioLevelIndicationPayload**: `object` + +## Type declaration + +### level + +> **level**: `number` + +### v + +> **v**: `boolean` diff --git a/doc/type-aliases/BundlePolicy.md b/doc/type-aliases/BundlePolicy.md new file mode 100644 index 000000000..7894ecc92 --- /dev/null +++ b/doc/type-aliases/BundlePolicy.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / BundlePolicy + +# Type Alias: BundlePolicy + +> **BundlePolicy**: `"max-compat"` \| `"max-bundle"` \| `"disable"` diff --git a/doc/type-aliases/CipherSuites.md b/doc/type-aliases/CipherSuites.md new file mode 100644 index 000000000..1ba866689 --- /dev/null +++ b/doc/type-aliases/CipherSuites.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CipherSuites + +# Type Alias: CipherSuites + +> **CipherSuites**: *typeof* [`CipherSuite`](../variables/CipherSuite.md)\[keyof *typeof* [`CipherSuite`](../variables/CipherSuite.md)\] diff --git a/doc/type-aliases/ConnectionState.md b/doc/type-aliases/ConnectionState.md new file mode 100644 index 000000000..5253f50dd --- /dev/null +++ b/doc/type-aliases/ConnectionState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / ConnectionState + +# Type Alias: ConnectionState + +> **ConnectionState**: *typeof* [`ConnectionStates`](../variables/ConnectionStates.md)\[`number`\] diff --git a/doc/type-aliases/CurveTypes.md b/doc/type-aliases/CurveTypes.md new file mode 100644 index 000000000..e55b524bb --- /dev/null +++ b/doc/type-aliases/CurveTypes.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CurveTypes + +# Type Alias: CurveTypes + +> **CurveTypes**: *typeof* [`CurveType`](../variables/CurveType.md)\[keyof *typeof* [`CurveType`](../variables/CurveType.md)\] diff --git a/doc/type-aliases/DCState.md b/doc/type-aliases/DCState.md new file mode 100644 index 000000000..c35739d10 --- /dev/null +++ b/doc/type-aliases/DCState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DCState + +# Type Alias: DCState + +> **DCState**: `"open"` \| `"closed"` \| `"connecting"` \| `"closing"` diff --git a/doc/type-aliases/DepacketizerCodec.md b/doc/type-aliases/DepacketizerCodec.md new file mode 100644 index 000000000..c9442ad73 --- /dev/null +++ b/doc/type-aliases/DepacketizerCodec.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DepacketizerCodec + +# Type Alias: DepacketizerCodec + +> **DepacketizerCodec**: *typeof* [`depacketizerCodecs`](../variables/depacketizerCodecs.md)\[`number`\] \| `Lowercase`\<*typeof* [`depacketizerCodecs`](../variables/depacketizerCodecs.md)\[`number`\]\> diff --git a/doc/type-aliases/Direction.md b/doc/type-aliases/Direction.md new file mode 100644 index 000000000..8133de112 --- /dev/null +++ b/doc/type-aliases/Direction.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Direction + +# Type Alias: Direction + +> **Direction**: *typeof* [`Directions`](../variables/Directions.md)\[`number`\] diff --git a/doc/type-aliases/DtlsKeys.md b/doc/type-aliases/DtlsKeys.md new file mode 100644 index 000000000..9c9897be3 --- /dev/null +++ b/doc/type-aliases/DtlsKeys.md @@ -0,0 +1,23 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DtlsKeys + +# Type Alias: DtlsKeys + +> **DtlsKeys**: `object` + +## Type declaration + +### certPem + +> **certPem**: `string` + +### keyPem + +> **keyPem**: `string` + +### signatureHash + +> **signatureHash**: [`SignatureHash`](SignatureHash.md) diff --git a/doc/type-aliases/DtlsRole.md b/doc/type-aliases/DtlsRole.md new file mode 100644 index 000000000..59ff825a1 --- /dev/null +++ b/doc/type-aliases/DtlsRole.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DtlsRole + +# Type Alias: DtlsRole + +> **DtlsRole**: `"auto"` \| `"server"` \| `"client"` diff --git a/doc/type-aliases/DtlsState.md b/doc/type-aliases/DtlsState.md new file mode 100644 index 000000000..c5044f462 --- /dev/null +++ b/doc/type-aliases/DtlsState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DtlsState + +# Type Alias: DtlsState + +> **DtlsState**: *typeof* [`DtlsStates`](../variables/DtlsStates.md)\[`number`\] diff --git a/doc/type-aliases/Extension.md b/doc/type-aliases/Extension.md new file mode 100644 index 000000000..011207528 --- /dev/null +++ b/doc/type-aliases/Extension.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Extension + +# Type Alias: Extension + +> **Extension**: `object` + +## Type declaration + +### id + +> **id**: `number` + +### payload + +> **payload**: `Buffer` diff --git a/doc/type-aliases/HashAlgorithms.md b/doc/type-aliases/HashAlgorithms.md new file mode 100644 index 000000000..a0bec8f48 --- /dev/null +++ b/doc/type-aliases/HashAlgorithms.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / HashAlgorithms + +# Type Alias: HashAlgorithms + +> **HashAlgorithms**: *typeof* [`HashAlgorithm`](../variables/HashAlgorithm.md)\[keyof *typeof* [`HashAlgorithm`](../variables/HashAlgorithm.md)\] diff --git a/doc/type-aliases/IceGathererState.md b/doc/type-aliases/IceGathererState.md new file mode 100644 index 000000000..937a7ee99 --- /dev/null +++ b/doc/type-aliases/IceGathererState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / IceGathererState + +# Type Alias: IceGathererState + +> **IceGathererState**: *typeof* [`IceGathererStates`](../variables/IceGathererStates.md)\[`number`\] diff --git a/doc/type-aliases/InterfaceAddresses.md b/doc/type-aliases/InterfaceAddresses.md new file mode 100644 index 000000000..9da01adfd --- /dev/null +++ b/doc/type-aliases/InterfaceAddresses.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / InterfaceAddresses + +# Type Alias: InterfaceAddresses + +> **InterfaceAddresses**: `{ [K in SocketType]?: string }` diff --git a/doc/type-aliases/Kind.md b/doc/type-aliases/Kind.md new file mode 100644 index 000000000..ba8315124 --- /dev/null +++ b/doc/type-aliases/Kind.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Kind + +# Type Alias: Kind + +> **Kind**: `"audio"` \| `"video"` \| `"application"` \| `"unknown"` diff --git a/doc/type-aliases/NamedCurveAlgorithms.md b/doc/type-aliases/NamedCurveAlgorithms.md new file mode 100644 index 000000000..2f9da61ea --- /dev/null +++ b/doc/type-aliases/NamedCurveAlgorithms.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / NamedCurveAlgorithms + +# Type Alias: NamedCurveAlgorithms + +> **NamedCurveAlgorithms**: *typeof* [`NamedCurveAlgorithm`](../variables/NamedCurveAlgorithm.md)\[keyof *typeof* [`NamedCurveAlgorithm`](../variables/NamedCurveAlgorithm.md)\] diff --git a/doc/type-aliases/RTCIceConnectionState.md b/doc/type-aliases/RTCIceConnectionState.md new file mode 100644 index 000000000..09dc123d6 --- /dev/null +++ b/doc/type-aliases/RTCIceConnectionState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCIceConnectionState + +# Type Alias: RTCIceConnectionState + +> **RTCIceConnectionState**: *typeof* [`IceTransportStates`](../variables/IceTransportStates.md)\[`number`\] diff --git a/doc/type-aliases/RTCIceServer.md b/doc/type-aliases/RTCIceServer.md new file mode 100644 index 000000000..a67d8b359 --- /dev/null +++ b/doc/type-aliases/RTCIceServer.md @@ -0,0 +1,23 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCIceServer + +# Type Alias: RTCIceServer + +> **RTCIceServer**: `object` + +## Type declaration + +### credential? + +> `optional` **credential**: `string` + +### urls + +> **urls**: `string` + +### username? + +> `optional` **username**: `string` diff --git a/doc/type-aliases/RTCPFB.md b/doc/type-aliases/RTCPFB.md new file mode 100644 index 000000000..a0cc2e892 --- /dev/null +++ b/doc/type-aliases/RTCPFB.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCPFB + +# Type Alias: RTCPFB + +> **RTCPFB**: `object` + +## Type declaration + +### parameter? + +> `optional` **parameter**: `string` + +### type + +> **type**: `string` diff --git a/doc/type-aliases/RTCRtpSendParameters.md b/doc/type-aliases/RTCRtpSendParameters.md new file mode 100644 index 000000000..4ab3788a1 --- /dev/null +++ b/doc/type-aliases/RTCRtpSendParameters.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCRtpSendParameters + +# Type Alias: RTCRtpSendParameters + +> **RTCRtpSendParameters**: [`RTCRtpParameters`](../interfaces/RTCRtpParameters.md) diff --git a/doc/type-aliases/RTCSdpType.md b/doc/type-aliases/RTCSdpType.md new file mode 100644 index 000000000..8e7e6330b --- /dev/null +++ b/doc/type-aliases/RTCSdpType.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCSdpType + +# Type Alias: RTCSdpType + +> **RTCSdpType**: `"answer"` \| `"offer"` \| `"pranswer"` \| `"rollback"` diff --git a/doc/type-aliases/RTCSignalingState.md b/doc/type-aliases/RTCSignalingState.md new file mode 100644 index 000000000..32221c9b2 --- /dev/null +++ b/doc/type-aliases/RTCSignalingState.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCSignalingState + +# Type Alias: RTCSignalingState + +> **RTCSignalingState**: *typeof* [`SignalingStates`](../variables/SignalingStates.md)\[`number`\] diff --git a/doc/type-aliases/RequireAtLeastOne.md b/doc/type-aliases/RequireAtLeastOne.md new file mode 100644 index 000000000..2f8be63a8 --- /dev/null +++ b/doc/type-aliases/RequireAtLeastOne.md @@ -0,0 +1,13 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RequireAtLeastOne + +# Type Alias: RequireAtLeastOne\ + +> **RequireAtLeastOne**\<`T`\>: `{ [K in keyof T]-?: Required> & Partial>> }`\[keyof `T`\] + +## Type Parameters + +• **T** diff --git a/doc/type-aliases/RtcpPacket.md b/doc/type-aliases/RtcpPacket.md new file mode 100644 index 000000000..f778d19e3 --- /dev/null +++ b/doc/type-aliases/RtcpPacket.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RtcpPacket + +# Type Alias: RtcpPacket + +> **RtcpPacket**: [`RtcpRrPacket`](../classes/RtcpRrPacket.md) \| [`RtcpSrPacket`](../classes/RtcpSrPacket.md) \| [`RtcpPayloadSpecificFeedback`](../classes/RtcpPayloadSpecificFeedback.md) \| [`RtcpSourceDescriptionPacket`](../classes/RtcpSourceDescriptionPacket.md) \| [`RtcpTransportLayerFeedback`](../classes/RtcpTransportLayerFeedback.md) diff --git a/doc/type-aliases/SignatureAlgorithms.md b/doc/type-aliases/SignatureAlgorithms.md new file mode 100644 index 000000000..33ee563e1 --- /dev/null +++ b/doc/type-aliases/SignatureAlgorithms.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignatureAlgorithms + +# Type Alias: SignatureAlgorithms + +> **SignatureAlgorithms**: *typeof* [`SignatureAlgorithm`](../variables/SignatureAlgorithm.md)\[keyof *typeof* [`SignatureAlgorithm`](../variables/SignatureAlgorithm.md)\] diff --git a/doc/type-aliases/SignatureHash.md b/doc/type-aliases/SignatureHash.md new file mode 100644 index 000000000..637e74159 --- /dev/null +++ b/doc/type-aliases/SignatureHash.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignatureHash + +# Type Alias: SignatureHash + +> **SignatureHash**: `object` + +## Type declaration + +### hash + +> **hash**: [`HashAlgorithms`](HashAlgorithms.md) + +### signature + +> **signature**: [`SignatureAlgorithms`](SignatureAlgorithms.md) diff --git a/doc/type-aliases/SignatureSchemes.md b/doc/type-aliases/SignatureSchemes.md new file mode 100644 index 000000000..593619ca9 --- /dev/null +++ b/doc/type-aliases/SignatureSchemes.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignatureSchemes + +# Type Alias: SignatureSchemes + +> **SignatureSchemes**: *typeof* [`SignatureScheme`](../variables/SignatureScheme.md)\[keyof *typeof* [`SignatureScheme`](../variables/SignatureScheme.md)\] diff --git a/doc/type-aliases/TransportWideCCPayload.md b/doc/type-aliases/TransportWideCCPayload.md new file mode 100644 index 000000000..d3e2a10eb --- /dev/null +++ b/doc/type-aliases/TransportWideCCPayload.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / TransportWideCCPayload + +# Type Alias: TransportWideCCPayload + +> **TransportWideCCPayload**: `number` diff --git a/doc/variables/AttributeKeys.md b/doc/variables/AttributeKeys.md new file mode 100644 index 000000000..6d630700f --- /dev/null +++ b/doc/variables/AttributeKeys.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / AttributeKeys + +# Variable: AttributeKeys + +> `const` **AttributeKeys**: readonly [`"FINGERPRINT"`, `"MESSAGE-INTEGRITY"`, `"CHANGE-REQUEST"`, `"PRIORITY"`, `"USERNAME"`, `"ICE-CONTROLLING"`, `"SOURCE-ADDRESS"`, `"USE-CANDIDATE"`, `"ICE-CONTROLLED"`, `"ERROR-CODE"`, `"XOR-MAPPED-ADDRESS"`, `"CHANGED-ADDRESS"`, `"LIFETIME"`, `"REQUESTED-TRANSPORT"`, `"NONCE"`, `"REALM"`, `"XOR-RELAYED-ADDRESS"`, `"CHANNEL-NUMBER"`, `"XOR-PEER-ADDRESS"`, `"DATA"`, `"SOFTWARE"`, `"MAPPED-ADDRESS"`, `"RESPONSE-ORIGIN"`, `"OTHER-ADDRESS"`] diff --git a/doc/variables/COOKIE.md b/doc/variables/COOKIE.md new file mode 100644 index 000000000..f64f56e47 --- /dev/null +++ b/doc/variables/COOKIE.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / COOKIE + +# Variable: COOKIE + +> `const` **COOKIE**: `554869826` = `0x2112a442` diff --git a/doc/variables/CipherSuite.md b/doc/variables/CipherSuite.md new file mode 100644 index 000000000..1b70916d6 --- /dev/null +++ b/doc/variables/CipherSuite.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CipherSuite + +# Variable: CipherSuite + +> `const` **CipherSuite**: `object` + +## Type declaration + +### TLS\_ECDHE\_ECDSA\_WITH\_AES\_128\_GCM\_SHA256\_49195 + +> `readonly` **TLS\_ECDHE\_ECDSA\_WITH\_AES\_128\_GCM\_SHA256\_49195**: `49195` = `0xc02b` + +### TLS\_ECDHE\_RSA\_WITH\_AES\_128\_GCM\_SHA256\_49199 + +> `readonly` **TLS\_ECDHE\_RSA\_WITH\_AES\_128\_GCM\_SHA256\_49199**: `49199` = `0xc02f` diff --git a/doc/variables/CipherSuiteList.md b/doc/variables/CipherSuiteList.md new file mode 100644 index 000000000..2aeaffbfd --- /dev/null +++ b/doc/variables/CipherSuiteList.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CipherSuiteList + +# Variable: CipherSuiteList + +> `const` **CipherSuiteList**: [`CipherSuites`](../type-aliases/CipherSuites.md)[] diff --git a/doc/variables/ConnectionStates.md b/doc/variables/ConnectionStates.md new file mode 100644 index 000000000..b74806263 --- /dev/null +++ b/doc/variables/ConnectionStates.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / ConnectionStates + +# Variable: ConnectionStates + +> `const` **ConnectionStates**: readonly [`"closed"`, `"failed"`, `"disconnected"`, `"new"`, `"connecting"`, `"connected"`] diff --git a/doc/variables/CurveType.md b/doc/variables/CurveType.md new file mode 100644 index 000000000..2cb037dcd --- /dev/null +++ b/doc/variables/CurveType.md @@ -0,0 +1,15 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / CurveType + +# Variable: CurveType + +> `const` **CurveType**: `object` + +## Type declaration + +### named\_curve\_3 + +> `readonly` **named\_curve\_3**: `3` = `3` diff --git a/doc/variables/Directions.md b/doc/variables/Directions.md new file mode 100644 index 000000000..1053cb001 --- /dev/null +++ b/doc/variables/Directions.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Directions + +# Variable: Directions + +> `const` **Directions**: readonly [`"inactive"`, `"sendonly"`, `"recvonly"`, `"sendrecv"`] diff --git a/doc/variables/DtlsStates.md b/doc/variables/DtlsStates.md new file mode 100644 index 000000000..13801b12d --- /dev/null +++ b/doc/variables/DtlsStates.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / DtlsStates + +# Variable: DtlsStates + +> `const` **DtlsStates**: readonly [`"new"`, `"connecting"`, `"connected"`, `"closed"`, `"failed"`] diff --git a/doc/variables/ExtensionProfiles.md b/doc/variables/ExtensionProfiles.md new file mode 100644 index 000000000..c45664127 --- /dev/null +++ b/doc/variables/ExtensionProfiles.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / ExtensionProfiles + +# Variable: ExtensionProfiles + +> `const` **ExtensionProfiles**: `object` + +## Type declaration + +### OneByte + +> `readonly` **OneByte**: `48862` = `0xbede` + +### TwoByte + +> `readonly` **TwoByte**: `4096` = `0x1000` diff --git a/doc/variables/FINGERPRINT_LENGTH.md b/doc/variables/FINGERPRINT_LENGTH.md new file mode 100644 index 000000000..769cf3b9f --- /dev/null +++ b/doc/variables/FINGERPRINT_LENGTH.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / FINGERPRINT\_LENGTH + +# Variable: FINGERPRINT\_LENGTH + +> `const` **FINGERPRINT\_LENGTH**: `8` = `8` diff --git a/doc/variables/FINGERPRINT_XOR.md b/doc/variables/FINGERPRINT_XOR.md new file mode 100644 index 000000000..8ec00e4ab --- /dev/null +++ b/doc/variables/FINGERPRINT_XOR.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / FINGERPRINT\_XOR + +# Variable: FINGERPRINT\_XOR + +> `const` **FINGERPRINT\_XOR**: `1398035790` = `0x5354554e` diff --git a/doc/variables/HEADER_LENGTH.md b/doc/variables/HEADER_LENGTH.md new file mode 100644 index 000000000..9cb6d1347 --- /dev/null +++ b/doc/variables/HEADER_LENGTH.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / HEADER\_LENGTH + +# Variable: HEADER\_LENGTH + +> `const` **HEADER\_LENGTH**: `20` = `20` diff --git a/doc/variables/HashAlgorithm.md b/doc/variables/HashAlgorithm.md new file mode 100644 index 000000000..55f8649e6 --- /dev/null +++ b/doc/variables/HashAlgorithm.md @@ -0,0 +1,15 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / HashAlgorithm + +# Variable: HashAlgorithm + +> `const` **HashAlgorithm**: `object` + +## Type declaration + +### sha256\_4 + +> `readonly` **sha256\_4**: `4` = `4` diff --git a/doc/variables/INTEGRITY_LENGTH.md b/doc/variables/INTEGRITY_LENGTH.md new file mode 100644 index 000000000..2342495a2 --- /dev/null +++ b/doc/variables/INTEGRITY_LENGTH.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / INTEGRITY\_LENGTH + +# Variable: INTEGRITY\_LENGTH + +> `const` **INTEGRITY\_LENGTH**: `24` = `24` diff --git a/doc/variables/IPV4_PROTOCOL.md b/doc/variables/IPV4_PROTOCOL.md new file mode 100644 index 000000000..991fb834d --- /dev/null +++ b/doc/variables/IPV4_PROTOCOL.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / IPV4\_PROTOCOL + +# Variable: IPV4\_PROTOCOL + +> `const` **IPV4\_PROTOCOL**: `1` = `1` diff --git a/doc/variables/IPV6_PROTOCOL.md b/doc/variables/IPV6_PROTOCOL.md new file mode 100644 index 000000000..19bfd8d8c --- /dev/null +++ b/doc/variables/IPV6_PROTOCOL.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / IPV6\_PROTOCOL + +# Variable: IPV6\_PROTOCOL + +> `const` **IPV6\_PROTOCOL**: `2` = `2` diff --git a/doc/variables/IceGathererStates.md b/doc/variables/IceGathererStates.md new file mode 100644 index 000000000..683ae9d57 --- /dev/null +++ b/doc/variables/IceGathererStates.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / IceGathererStates + +# Variable: IceGathererStates + +> `const` **IceGathererStates**: readonly [`"new"`, `"gathering"`, `"complete"`] diff --git a/doc/variables/IceTransportStates.md b/doc/variables/IceTransportStates.md new file mode 100644 index 000000000..2279a4048 --- /dev/null +++ b/doc/variables/IceTransportStates.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / IceTransportStates + +# Variable: IceTransportStates + +> `const` **IceTransportStates**: readonly [`"new"`, `"checking"`, `"connected"`, `"completed"`, `"disconnected"`, `"failed"`, `"closed"`] diff --git a/doc/variables/Inactive.md b/doc/variables/Inactive.md new file mode 100644 index 000000000..9e00fe8fc --- /dev/null +++ b/doc/variables/Inactive.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Inactive + +# Variable: Inactive + +> `const` **Inactive**: `"inactive"` = `"inactive"` diff --git a/doc/variables/NalUnitType.md b/doc/variables/NalUnitType.md new file mode 100644 index 000000000..a782b8f66 --- /dev/null +++ b/doc/variables/NalUnitType.md @@ -0,0 +1,39 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / NalUnitType + +# Variable: NalUnitType + +> `const` **NalUnitType**: `object` + +## Type declaration + +### fu\_a + +> `readonly` **fu\_a**: `28` = `28` + +### fu\_b + +> `readonly` **fu\_b**: `29` = `29` + +### idrSlice + +> `readonly` **idrSlice**: `5` = `5` + +### mtap16 + +> `readonly` **mtap16**: `26` = `26` + +### mtap24 + +> `readonly` **mtap24**: `27` = `27` + +### stap\_a + +> `readonly` **stap\_a**: `24` = `24` + +### stap\_b + +> `readonly` **stap\_b**: `25` = `25` diff --git a/doc/variables/NamedCurveAlgorithm.md b/doc/variables/NamedCurveAlgorithm.md new file mode 100644 index 000000000..c883e60d8 --- /dev/null +++ b/doc/variables/NamedCurveAlgorithm.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / NamedCurveAlgorithm + +# Variable: NamedCurveAlgorithm + +> `const` **NamedCurveAlgorithm**: `object` + +## Type declaration + +### secp256r1\_23 + +> `readonly` **secp256r1\_23**: `23` = `23` + +### x25519\_29 + +> `readonly` **x25519\_29**: `29` = `29` diff --git a/doc/variables/NamedCurveAlgorithmList.md b/doc/variables/NamedCurveAlgorithmList.md new file mode 100644 index 000000000..3154713c7 --- /dev/null +++ b/doc/variables/NamedCurveAlgorithmList.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / NamedCurveAlgorithmList + +# Variable: NamedCurveAlgorithmList + +> `const` **NamedCurveAlgorithmList**: [`NamedCurveAlgorithms`](../type-aliases/NamedCurveAlgorithms.md)[] diff --git a/doc/variables/RETRY_MAX.md b/doc/variables/RETRY_MAX.md new file mode 100644 index 000000000..f433cdd94 --- /dev/null +++ b/doc/variables/RETRY_MAX.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RETRY\_MAX + +# Variable: RETRY\_MAX + +> `const` **RETRY\_MAX**: `6` = `6` diff --git a/doc/variables/RETRY_RTO.md b/doc/variables/RETRY_RTO.md new file mode 100644 index 000000000..65342791d --- /dev/null +++ b/doc/variables/RETRY_RTO.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RETRY\_RTO + +# Variable: RETRY\_RTO + +> `const` **RETRY\_RTO**: `50` = `50` diff --git a/doc/variables/RTCP_HEADER_SIZE.md b/doc/variables/RTCP_HEADER_SIZE.md new file mode 100644 index 000000000..ff835c373 --- /dev/null +++ b/doc/variables/RTCP_HEADER_SIZE.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTCP\_HEADER\_SIZE + +# Variable: RTCP\_HEADER\_SIZE + +> `const` **RTCP\_HEADER\_SIZE**: `4` = `4` diff --git a/doc/variables/RTP_EXTENSION_URI.md b/doc/variables/RTP_EXTENSION_URI.md new file mode 100644 index 000000000..c9f3a4adb --- /dev/null +++ b/doc/variables/RTP_EXTENSION_URI.md @@ -0,0 +1,39 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / RTP\_EXTENSION\_URI + +# Variable: RTP\_EXTENSION\_URI + +> `const` **RTP\_EXTENSION\_URI**: `object` + +## Type declaration + +### absSendTime + +> `readonly` **absSendTime**: `"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"` = `"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"` + +### audioLevelIndication + +> `readonly` **audioLevelIndication**: `"urn:ietf:params:rtp-hdrext:ssrc-audio-level"` = `"urn:ietf:params:rtp-hdrext:ssrc-audio-level"` + +### dependencyDescriptor + +> `readonly` **dependencyDescriptor**: `"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"` = `"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"` + +### repairedRtpStreamId + +> `readonly` **repairedRtpStreamId**: `"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"` = `"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"` + +### sdesMid + +> `readonly` **sdesMid**: `"urn:ietf:params:rtp-hdrext:sdes:mid"` = `"urn:ietf:params:rtp-hdrext:sdes:mid"` + +### sdesRTPStreamID + +> `readonly` **sdesRTPStreamID**: `"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"` = `"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"` + +### transportWideCC + +> `readonly` **transportWideCC**: `"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"` = `"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"` diff --git a/doc/variables/Recvonly.md b/doc/variables/Recvonly.md new file mode 100644 index 000000000..8b29d7654 --- /dev/null +++ b/doc/variables/Recvonly.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Recvonly + +# Variable: Recvonly + +> `const` **Recvonly**: `"recvonly"` = `"recvonly"` diff --git a/doc/variables/Sendonly.md b/doc/variables/Sendonly.md new file mode 100644 index 000000000..12a6965f7 --- /dev/null +++ b/doc/variables/Sendonly.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Sendonly + +# Variable: Sendonly + +> `const` **Sendonly**: `"sendonly"` = `"sendonly"` diff --git a/doc/variables/Sendrecv.md b/doc/variables/Sendrecv.md new file mode 100644 index 000000000..e1261dbb4 --- /dev/null +++ b/doc/variables/Sendrecv.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / Sendrecv + +# Variable: Sendrecv + +> `const` **Sendrecv**: `"sendrecv"` = `"sendrecv"` diff --git a/doc/variables/SignalingStates.md b/doc/variables/SignalingStates.md new file mode 100644 index 000000000..4c3c8d3d2 --- /dev/null +++ b/doc/variables/SignalingStates.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignalingStates + +# Variable: SignalingStates + +> `const` **SignalingStates**: readonly [`"stable"`, `"have-local-offer"`, `"have-remote-offer"`, `"have-local-pranswer"`, `"have-remote-pranswer"`, `"closed"`] diff --git a/doc/variables/SignatureAlgorithm.md b/doc/variables/SignatureAlgorithm.md new file mode 100644 index 000000000..17c8974c8 --- /dev/null +++ b/doc/variables/SignatureAlgorithm.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignatureAlgorithm + +# Variable: SignatureAlgorithm + +> `const` **SignatureAlgorithm**: `object` + +## Type declaration + +### ecdsa\_3 + +> `readonly` **ecdsa\_3**: `3` = `3` + +### rsa\_1 + +> `readonly` **rsa\_1**: `1` = `1` diff --git a/doc/variables/SignatureScheme.md b/doc/variables/SignatureScheme.md new file mode 100644 index 000000000..317323e52 --- /dev/null +++ b/doc/variables/SignatureScheme.md @@ -0,0 +1,19 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / SignatureScheme + +# Variable: SignatureScheme + +> `const` **SignatureScheme**: `object` + +## Type declaration + +### ecdsa\_secp256r1\_sha256 + +> `readonly` **ecdsa\_secp256r1\_sha256**: `1027` = `0x0403` + +### rsa\_pkcs1\_sha256 + +> `readonly` **rsa\_pkcs1\_sha256**: `1025` = `0x0401` diff --git a/doc/variables/certificateTypes.md b/doc/variables/certificateTypes.md new file mode 100644 index 000000000..fc1caf3a1 --- /dev/null +++ b/doc/variables/certificateTypes.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / certificateTypes + +# Variable: certificateTypes + +> `const` **certificateTypes**: `number`[] diff --git a/doc/variables/defaultPeerConfig.md b/doc/variables/defaultPeerConfig.md new file mode 100644 index 000000000..129c7bc5b --- /dev/null +++ b/doc/variables/defaultPeerConfig.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / defaultPeerConfig + +# Variable: defaultPeerConfig + +> `const` **defaultPeerConfig**: [`PeerConfig`](../interfaces/PeerConfig.md) diff --git a/doc/variables/depacketizerCodecs.md b/doc/variables/depacketizerCodecs.md new file mode 100644 index 000000000..e84ae3e1d --- /dev/null +++ b/doc/variables/depacketizerCodecs.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / depacketizerCodecs + +# Variable: depacketizerCodecs + +> `const` **depacketizerCodecs**: readonly [`"MPEG4/ISO/AVC"`, `"VP8"`, `"VP9"`, `"OPUS"`, `"AV1"`] diff --git a/doc/variables/signatures.md b/doc/variables/signatures.md new file mode 100644 index 000000000..96f72bbd7 --- /dev/null +++ b/doc/variables/signatures.md @@ -0,0 +1,9 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / signatures + +# Variable: signatures + +> `const` **signatures**: (`object` \| `object`)[] diff --git a/doc/variables/timer.md b/doc/variables/timer.md new file mode 100644 index 000000000..fec1eb4fe --- /dev/null +++ b/doc/variables/timer.md @@ -0,0 +1,43 @@ +[**werift**](../README.md) • **Docs** + +*** + +[werift](../globals.md) / timer + +# Variable: timer + +> `const` **timer**: `object` + +## Type declaration + +### setInterval() + +> **setInterval**: (...`args`) => () => `void` + +#### Parameters + +• ...**args**: [(`args`) => `void`, `number`] + +#### Returns + +`Function` + +##### Returns + +`void` + +### setTimeout() + +> **setTimeout**: (...`args`) => () => `void` + +#### Parameters + +• ...**args**: [(`args`) => `void`, `number`] + +#### Returns + +`Function` + +##### Returns + +`void` diff --git a/packages/ice/doc/README.md b/packages/ice/doc/README.md new file mode 100644 index 000000000..dac559f0d --- /dev/null +++ b/packages/ice/doc/README.md @@ -0,0 +1,8 @@ +**werift-ice** • [**Docs**](globals.md) + +*** + +# werift-ice + +ICE/STUN-client/TURN-client Implementation for TypeScript +based on aioice diff --git a/packages/ice/doc/classes/Candidate.md b/packages/ice/doc/classes/Candidate.md new file mode 100644 index 000000000..0f41f0cb2 --- /dev/null +++ b/packages/ice/doc/classes/Candidate.md @@ -0,0 +1,145 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Candidate + +# Class: Candidate + +## Constructors + +### new Candidate() + +> **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress`?, `relatedPort`?, `tcptype`?, `generation`?): [`Candidate`](Candidate.md) + +#### Parameters + +• **foundation**: `string` + +• **component**: `number` + +• **transport**: `string` + +• **priority**: `number` + +• **host**: `string` + +• **port**: `number` + +• **type**: `string` + +• **relatedAddress?**: `string` + +• **relatedPort?**: `number` + +• **tcptype?**: `string` + +• **generation?**: `number` + +#### Returns + +[`Candidate`](Candidate.md) + +## Properties + +### component + +> **component**: `number` + +*** + +### foundation + +> **foundation**: `string` + +*** + +### generation? + +> `optional` **generation**: `number` + +*** + +### host + +> **host**: `string` + +*** + +### port + +> **port**: `number` + +*** + +### priority + +> **priority**: `number` + +*** + +### relatedAddress? + +> `optional` **relatedAddress**: `string` + +*** + +### relatedPort? + +> `optional` **relatedPort**: `number` + +*** + +### tcptype? + +> `optional` **tcptype**: `string` + +*** + +### transport + +> **transport**: `string` + +*** + +### type + +> **type**: `string` + +## Methods + +### canPairWith() + +> **canPairWith**(`other`): `boolean` + +#### Parameters + +• **other**: [`Candidate`](Candidate.md) + +#### Returns + +`boolean` + +*** + +### toSdp() + +> **toSdp**(): `string` + +#### Returns + +`string` + +*** + +### fromSdp() + +> `static` **fromSdp**(`sdp`): [`Candidate`](Candidate.md) + +#### Parameters + +• **sdp**: `string` + +#### Returns + +[`Candidate`](Candidate.md) diff --git a/packages/ice/doc/classes/CandidatePair.md b/packages/ice/doc/classes/CandidatePair.md new file mode 100644 index 000000000..fa05b2fbe --- /dev/null +++ b/packages/ice/doc/classes/CandidatePair.md @@ -0,0 +1,145 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / CandidatePair + +# Class: CandidatePair + +## Constructors + +### new CandidatePair() + +> **new CandidatePair**(`protocol`, `remoteCandidate`): [`CandidatePair`](CandidatePair.md) + +#### Parameters + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +• **remoteCandidate**: [`Candidate`](Candidate.md) + +#### Returns + +[`CandidatePair`](CandidatePair.md) + +## Properties + +### handle? + +> `optional` **handle**: `object` + +#### cancel() + +> **cancel**: () => `void` + +##### Returns + +`void` + +#### done() + +> **done**: () => `boolean` + +##### Returns + +`boolean` + +#### promise + +> **promise**: `PCancelable`\<`any`\> = `pCancel` + +*** + +### nominated + +> **nominated**: `boolean` = `false` + +*** + +### protocol + +> **protocol**: [`Protocol`](../interfaces/Protocol.md) + +*** + +### remoteCandidate + +> **remoteCandidate**: [`Candidate`](Candidate.md) + +*** + +### remoteNominated + +> **remoteNominated**: `boolean` = `false` + +## Accessors + +### component + +> `get` **component**(): `number` + +#### Returns + +`number` + +*** + +### localCandidate + +> `get` **localCandidate**(): [`Candidate`](Candidate.md) + +#### Returns + +[`Candidate`](Candidate.md) + +*** + +### remoteAddr + +> `get` **remoteAddr**(): readonly [`string`, `number`] + +#### Returns + +readonly [`string`, `number`] + +*** + +### state + +> `get` **state**(): [`CandidatePairState`](../enumerations/CandidatePairState.md) + +#### Returns + +[`CandidatePairState`](../enumerations/CandidatePairState.md) + +## Methods + +### toJSON() + +> **toJSON**(): `object` + +#### Returns + +`object` + +##### protocol + +> **protocol**: `string` + +##### remoteAddr + +> **remoteAddr**: readonly [`string`, `number`] + +*** + +### updateState() + +> **updateState**(`state`): `void` + +#### Parameters + +• **state**: [`CandidatePairState`](../enumerations/CandidatePairState.md) + +#### Returns + +`void` diff --git a/packages/ice/doc/classes/Connection.md b/packages/ice/doc/classes/Connection.md new file mode 100644 index 000000000..41189e849 --- /dev/null +++ b/packages/ice/doc/classes/Connection.md @@ -0,0 +1,341 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Connection + +# Class: Connection + +## Constructors + +### new Connection() + +> **new Connection**(`iceControlling`, `options`?): [`Connection`](Connection.md) + +#### Parameters + +• **iceControlling**: `boolean` + +• **options?**: `Partial`\<[`IceOptions`](../interfaces/IceOptions.md)\> + +#### Returns + +[`Connection`](Connection.md) + +## Properties + +### \_localCandidatesEnd + +> **\_localCandidatesEnd**: `boolean` = `false` + +*** + +### \_tieBreaker + +> **\_tieBreaker**: `bigint` + +*** + +### checkList + +> **checkList**: [`CandidatePair`](CandidatePair.md)[] = `[]` + +*** + +### iceControlling + +> **iceControlling**: `boolean` + +*** + +### localCandidates + +> **localCandidates**: [`Candidate`](Candidate.md)[] = `[]` + +*** + +### localPassword + +> **localPassword**: `string` + +*** + +### localUserName + +> **localUserName**: `string` + +*** + +### lookup? + +> `optional` **lookup**: `MdnsLookup` + +*** + +### nominated? + +> `optional` **nominated**: [`CandidatePair`](CandidatePair.md) + +*** + +### onData + +> `readonly` **onData**: `Event`\<[`Buffer`, `number`]\> + +*** + +### options + +> **options**: [`IceOptions`](../interfaces/IceOptions.md) + +*** + +### remoteCandidatesEnd + +> **remoteCandidatesEnd**: `boolean` = `false` + +*** + +### remoteIsLite + +> **remoteIsLite**: `boolean` = `false` + +*** + +### remotePassword + +> **remotePassword**: `string` = `""` + +*** + +### remoteUsername + +> **remoteUsername**: `string` = `""` + +*** + +### restarted + +> **restarted**: `boolean` = `false` + +*** + +### state + +> **state**: `IceState` = `"new"` + +*** + +### stateChanged + +> `readonly` **stateChanged**: `Event`\<[`IceState`]\> + +*** + +### stunServer? + +> `optional` **stunServer**: readonly [`string`, `number`] + +*** + +### turnServer? + +> `optional` **turnServer**: readonly [`string`, `number`] + +*** + +### useIpv4 + +> **useIpv4**: `boolean` + +*** + +### useIpv6 + +> **useIpv6**: `boolean` + +## Accessors + +### remoteCandidates + +> `get` **remoteCandidates**(): [`Candidate`](Candidate.md)[] + +> `set` **remoteCandidates**(`value`): `void` + +#### Parameters + +• **value**: [`Candidate`](Candidate.md)[] + +#### Returns + +[`Candidate`](Candidate.md)[] + +## Methods + +### addRemoteCandidate() + +> **addRemoteCandidate**(`remoteCandidate`): `Promise`\<`void`\> + +#### Parameters + +• **remoteCandidate**: `undefined` \| [`Candidate`](Candidate.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### checkIncoming() + +> **checkIncoming**(`message`, `addr`, `protocol`): `void` + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +#### Returns + +`void` + +*** + +### checkStart() + +> **checkStart**(`pair`): `PCancelable`\<`unknown`\> + +#### Parameters + +• **pair**: [`CandidatePair`](CandidatePair.md) + +#### Returns + +`PCancelable`\<`unknown`\> + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### connect() + +> **connect**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### dataReceived() + +> **dataReceived**(`data`, `component`): `void` + +#### Parameters + +• **data**: `Buffer` + +• **component**: `number` + +#### Returns + +`void` + +*** + +### gatherCandidates() + +> **gatherCandidates**(`cb`?): `Promise`\<`void`\> + +#### Parameters + +• **cb?** + +#### Returns + +`Promise`\<`void`\> + +*** + +### getDefaultCandidate() + +> **getDefaultCandidate**(): [`Candidate`](Candidate.md) + +#### Returns + +[`Candidate`](Candidate.md) + +*** + +### requestReceived() + +> **requestReceived**(`message`, `addr`, `protocol`, `rawData`): `void` + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +• **rawData**: `Buffer` + +#### Returns + +`void` + +*** + +### resetNominatedPair() + +> **resetNominatedPair**(): `void` + +#### Returns + +`void` + +*** + +### send() + +> **send**(`data`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +#### Returns + +`Promise`\<`void`\> + +*** + +### setRemoteParams() + +> **setRemoteParams**(`__namedParameters`): `void` + +#### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.iceLite**: `boolean` + +• **\_\_namedParameters.password**: `string` + +• **\_\_namedParameters.usernameFragment**: `string` + +#### Returns + +`void` diff --git a/packages/ice/doc/classes/Message.md b/packages/ice/doc/classes/Message.md new file mode 100644 index 000000000..0355ef936 --- /dev/null +++ b/packages/ice/doc/classes/Message.md @@ -0,0 +1,219 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Message + +# Class: Message + +## Extends + +- `AttributeRepository` + +## Constructors + +### new Message() + +> **new Message**(`messageMethod`, `messageClass`, `transactionId`, `attributes`): [`Message`](Message.md) + +#### Parameters + +• **messageMethod**: [`methods`](../enumerations/methods.md) + +• **messageClass**: [`classes`](../enumerations/classes.md) + +• **transactionId**: `Buffer` = `...` + +• **attributes**: `AttributePair`[] = `[]` + +#### Returns + +[`Message`](Message.md) + +#### Overrides + +`AttributeRepository.constructor` + +## Properties + +### attributes + +> `protected` **attributes**: `AttributePair`[] = `[]` + +#### Inherited from + +`AttributeRepository.attributes` + +*** + +### messageClass + +> **messageClass**: [`classes`](../enumerations/classes.md) + +*** + +### messageMethod + +> **messageMethod**: [`methods`](../enumerations/methods.md) + +*** + +### transactionId + +> **transactionId**: `Buffer` + +## Accessors + +### attributesKeys + +> `get` **attributesKeys**(): (`"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"`)[] + +#### Returns + +(`"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"`)[] + +#### Inherited from + +`AttributeRepository.attributesKeys` + +*** + +### bytes + +> `get` **bytes**(): `Buffer` + +#### Returns + +`Buffer` + +*** + +### transactionIdHex + +> `get` **transactionIdHex**(): `string` + +#### Returns + +`string` + +## Methods + +### addFingerprint() + +> **addFingerprint**(): `void` + +#### Returns + +`void` + +*** + +### addMessageIntegrity() + +> **addMessageIntegrity**(`key`): [`Message`](Message.md) + +#### Parameters + +• **key**: `Buffer` + +#### Returns + +[`Message`](Message.md) + +*** + +### clear() + +> **clear**(): `void` + +#### Returns + +`void` + +#### Inherited from + +`AttributeRepository.clear` + +*** + +### getAttributeValue() + +> **getAttributeValue**(`key`): `any` + +#### Parameters + +• **key**: `"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"` + +#### Returns + +`any` + +#### Inherited from + +`AttributeRepository.getAttributeValue` + +*** + +### getAttributes() + +> **getAttributes**(): `AttributePair`[] + +#### Returns + +`AttributePair`[] + +#### Inherited from + +`AttributeRepository.getAttributes` + +*** + +### messageIntegrity() + +> **messageIntegrity**(`key`): `Buffer` + +#### Parameters + +• **key**: `Buffer` + +#### Returns + +`Buffer` + +*** + +### setAttribute() + +> **setAttribute**(`key`, `value`): [`Message`](Message.md) + +#### Parameters + +• **key**: `"FINGERPRINT"` \| `"MESSAGE-INTEGRITY"` \| `"CHANGE-REQUEST"` \| `"PRIORITY"` \| `"USERNAME"` \| `"ICE-CONTROLLING"` \| `"SOURCE-ADDRESS"` \| `"USE-CANDIDATE"` \| `"ICE-CONTROLLED"` \| `"ERROR-CODE"` \| `"XOR-MAPPED-ADDRESS"` \| `"CHANGED-ADDRESS"` \| `"LIFETIME"` \| `"REQUESTED-TRANSPORT"` \| `"NONCE"` \| `"REALM"` \| `"XOR-RELAYED-ADDRESS"` \| `"CHANNEL-NUMBER"` \| `"XOR-PEER-ADDRESS"` \| `"DATA"` \| `"SOFTWARE"` \| `"MAPPED-ADDRESS"` \| `"RESPONSE-ORIGIN"` \| `"OTHER-ADDRESS"` + +• **value**: `any` + +#### Returns + +[`Message`](Message.md) + +#### Inherited from + +`AttributeRepository.setAttribute` + +*** + +### toJSON() + +> **toJSON**(): `object` + +#### Returns + +`object` + +##### messageClass + +> **messageClass**: `string` + +##### messageMethod + +> **messageMethod**: `string` diff --git a/packages/ice/doc/classes/StunOverTurnProtocol.md b/packages/ice/doc/classes/StunOverTurnProtocol.md new file mode 100644 index 000000000..6e90920b0 --- /dev/null +++ b/packages/ice/doc/classes/StunOverTurnProtocol.md @@ -0,0 +1,149 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / StunOverTurnProtocol + +# Class: StunOverTurnProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new StunOverTurnProtocol() + +> **new StunOverTurnProtocol**(`turn`, `ice`): [`StunOverTurnProtocol`](StunOverTurnProtocol.md) + +#### Parameters + +• **turn**: [`TurnProtocol`](TurnProtocol.md) + +• **ice**: [`Connection`](Connection.md) + +#### Returns + +[`StunOverTurnProtocol`](StunOverTurnProtocol.md) + +## Properties + +### localCandidate + +> **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### turn + +> **turn**: [`TurnProtocol`](TurnProtocol.md) + +*** + +### type + +> `readonly` **type**: `string` = `StunOverTurnProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### type + +> `static` **type**: `string` = `"turn"` + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionMade() + +> **connectionMade**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### request() + +> **request**(`request`, `addr`, `integrityKey`?): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **integrityKey?**: `Buffer` + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/packages/ice/doc/classes/StunProtocol.md b/packages/ice/doc/classes/StunProtocol.md new file mode 100644 index 000000000..a022ba234 --- /dev/null +++ b/packages/ice/doc/classes/StunProtocol.md @@ -0,0 +1,219 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / StunProtocol + +# Class: StunProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new StunProtocol() + +> **new StunProtocol**(`receiver`?): [`StunProtocol`](StunProtocol.md) + +#### Parameters + +• **receiver?**: [`Connection`](Connection.md) + +#### Returns + +[`StunProtocol`](StunProtocol.md) + +## Properties + +### localAddress? + +> `optional` **localAddress**: `string` + +*** + +### localCandidate? + +> `optional` **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### receiver? + +> `optional` **receiver**: [`Connection`](Connection.md) + +*** + +### sentMessage? + +> `optional` **sentMessage**: [`Message`](Message.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sentMessage`](../interfaces/Protocol.md#sentmessage) + +*** + +### transactions + +> **transactions**: `object` = `{}` + +#### Index Signature + + \[`key`: `string`\]: `Transaction` + +*** + +### transport + +> **transport**: [`UdpTransport`](UdpTransport.md) + +*** + +### type + +> `readonly` **type**: `"stun"` = `StunProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### type + +> `readonly` `static` **type**: `"stun"` = `"stun"` + +## Accessors + +### transactionsKeys + +> `get` **transactionsKeys**(): `string`[] + +#### Returns + +`string`[] + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionLost() + +> **connectionLost**(): `void` + +#### Returns + +`void` + +*** + +### connectionMade() + +> **connectionMade**(`useIpv4`, `portRange`?, `interfaceAddresses`?): `Promise`\<`void`\> + +#### Parameters + +• **useIpv4**: `boolean` + +• **portRange?**: [`number`, `number`] + +• **interfaceAddresses?**: `InterfaceAddresses` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### getExtraInfo() + +> **getExtraInfo**(): readonly [`string`, `number`] + +#### Returns + +readonly [`string`, `number`] + +*** + +### request() + +> **request**(`request`, `addr`, `integrityKey`?, `retransmissions`?): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +• **integrityKey?**: `Buffer` + +• **retransmissions?**: `number` + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/packages/ice/doc/classes/TcpTransport.md b/packages/ice/doc/classes/TcpTransport.md new file mode 100644 index 000000000..c410f49c9 --- /dev/null +++ b/packages/ice/doc/classes/TcpTransport.md @@ -0,0 +1,95 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / TcpTransport + +# Class: TcpTransport + +## Implements + +- [`Transport`](../interfaces/Transport.md) + +## Properties + +### closed + +> **closed**: `boolean` = `false` + +*** + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`onData`](../interfaces/Transport.md#ondata) + +*** + +### type + +> `readonly` **type**: `"tcp"` = `"tcp"` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`type`](../interfaces/Transport.md#type) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`close`](../interfaces/Transport.md#close) + +*** + +### send() + +> **send**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`send`](../interfaces/Transport.md#send) + +*** + +### init() + +> `static` **init**(`addr`): `Promise`\<[`TcpTransport`](TcpTransport.md)\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[`TcpTransport`](TcpTransport.md)\> diff --git a/packages/ice/doc/classes/TurnProtocol.md b/packages/ice/doc/classes/TurnProtocol.md new file mode 100644 index 000000000..59a434638 --- /dev/null +++ b/packages/ice/doc/classes/TurnProtocol.md @@ -0,0 +1,293 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / TurnProtocol + +# Class: TurnProtocol + +## Implements + +- [`Protocol`](../interfaces/Protocol.md) + +## Constructors + +### new TurnProtocol() + +> **new TurnProtocol**(`server`, `username`, `password`, `lifetime`, `transport`, `options`): [`TurnProtocol`](TurnProtocol.md) + +#### Parameters + +• **server**: readonly [`string`, `number`] + +• **username**: `string` + +• **password**: `string` + +• **lifetime**: `number` + +• **transport**: [`Transport`](../interfaces/Transport.md) + +• **options** = `{}` + +• **options.channelRefreshTime?**: `number` + +sec + +#### Returns + +[`TurnProtocol`](TurnProtocol.md) + +## Properties + +### integrityKey? + +> `optional` **integrityKey**: `Buffer` + +*** + +### lifetime + +> **lifetime**: `number` + +*** + +### localCandidate + +> **localCandidate**: [`Candidate`](Candidate.md) + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`localCandidate`](../interfaces/Protocol.md#localcandidate) + +*** + +### mappedAddress + +> **mappedAddress**: readonly [`string`, `number`] + +*** + +### nonce? + +> `optional` **nonce**: `Buffer` + +*** + +### onData + +> `readonly` **onData**: `Event`\<[`Buffer`, readonly [`string`, `number`]]\> + +*** + +### options + +> **options**: `object` = `{}` + +#### channelRefreshTime? + +> `optional` **channelRefreshTime**: `number` + +sec + +*** + +### password + +> **password**: `string` + +*** + +### realm? + +> `optional` **realm**: `string` + +*** + +### relayedAddress + +> **relayedAddress**: readonly [`string`, `number`] + +*** + +### server + +> **server**: readonly [`string`, `number`] + +*** + +### transactions + +> **transactions**: `object` = `{}` + +#### Index Signature + + \[`hexId`: `string`\]: `Transaction` + +*** + +### transport + +> **transport**: [`Transport`](../interfaces/Transport.md) + +*** + +### type + +> `readonly` **type**: `string` = `TurnProtocol.type` + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`type`](../interfaces/Protocol.md#type) + +*** + +### username + +> **username**: `string` + +*** + +### type + +> `static` **type**: `string` = `"turn"` + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`close`](../interfaces/Protocol.md#close) + +*** + +### connectionMade() + +> **connectionMade**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`connectionMade`](../interfaces/Protocol.md#connectionmade) + +*** + +### getChannel() + +> **getChannel**(`addr`): `Promise`\<`object`\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`object`\> + +##### address + +> **address**: readonly [`string`, `number`] + +##### number + +> **number**: `number` + +*** + +### getPermission() + +> **getPermission**(`addr`): `Promise`\<`void`\> + +#### Parameters + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### request() + +> **request**(`request`, `addr`): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`request`](../interfaces/Protocol.md#request) + +*** + +### requestWithRetry() + +> **requestWithRetry**(`request`, `addr`): `Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **request**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<[[`Message`](Message.md), readonly [`string`, `number`]]\> + +*** + +### sendData() + +> **sendData**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendData`](../interfaces/Protocol.md#senddata) + +*** + +### sendStun() + +> **sendStun**(`message`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Protocol`](../interfaces/Protocol.md).[`sendStun`](../interfaces/Protocol.md#sendstun) diff --git a/packages/ice/doc/classes/UdpTransport.md b/packages/ice/doc/classes/UdpTransport.md new file mode 100644 index 000000000..8894d7d32 --- /dev/null +++ b/packages/ice/doc/classes/UdpTransport.md @@ -0,0 +1,109 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / UdpTransport + +# Class: UdpTransport + +## Implements + +- [`Transport`](../interfaces/Transport.md) + +## Properties + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`onData`](../interfaces/Transport.md#ondata) + +*** + +### socket + +> `readonly` **socket**: `Socket` + +*** + +### type + +> `readonly` **type**: `"udp"` = `"udp"` + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`type`](../interfaces/Transport.md#type) + +## Methods + +### address() + +> **address**(): `AddressInfo` + +#### Returns + +`AddressInfo` + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`close`](../interfaces/Transport.md#close) + +*** + +### send() + +> **send**(`data`, `addr`): `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Transport`](../interfaces/Transport.md).[`send`](../interfaces/Transport.md#send) + +*** + +### init() + +> `static` **init**(`type`, `portRange`?, `interfaceAddresses`?): `Promise`\<[`UdpTransport`](UdpTransport.md)\> + +#### Parameters + +• **type**: `SocketType` + +• **portRange?**: [`number`, `number`] + +• **interfaceAddresses?**: `InterfaceAddresses` + +#### Returns + +`Promise`\<[`UdpTransport`](UdpTransport.md)\> diff --git a/packages/ice/doc/enumerations/CandidatePairState.md b/packages/ice/doc/enumerations/CandidatePairState.md new file mode 100644 index 000000000..7e69a6d55 --- /dev/null +++ b/packages/ice/doc/enumerations/CandidatePairState.md @@ -0,0 +1,37 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / CandidatePairState + +# Enumeration: CandidatePairState + +## Enumeration Members + +### FAILED + +> **FAILED**: `4` + +*** + +### FROZEN + +> **FROZEN**: `0` + +*** + +### IN\_PROGRESS + +> **IN\_PROGRESS**: `2` + +*** + +### SUCCEEDED + +> **SUCCEEDED**: `3` + +*** + +### WAITING + +> **WAITING**: `1` diff --git a/packages/ice/doc/enumerations/classes.md b/packages/ice/doc/enumerations/classes.md new file mode 100644 index 000000000..911dd162d --- /dev/null +++ b/packages/ice/doc/enumerations/classes.md @@ -0,0 +1,31 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / classes + +# Enumeration: classes + +## Enumeration Members + +### ERROR + +> **ERROR**: `272` + +*** + +### INDICATION + +> **INDICATION**: `16` + +*** + +### REQUEST + +> **REQUEST**: `0` + +*** + +### RESPONSE + +> **RESPONSE**: `256` diff --git a/packages/ice/doc/enumerations/methods.md b/packages/ice/doc/enumerations/methods.md new file mode 100644 index 000000000..d14b55472 --- /dev/null +++ b/packages/ice/doc/enumerations/methods.md @@ -0,0 +1,55 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / methods + +# Enumeration: methods + +## Enumeration Members + +### ALLOCATE + +> **ALLOCATE**: `3` + +*** + +### BINDING + +> **BINDING**: `1` + +*** + +### CHANNEL\_BIND + +> **CHANNEL\_BIND**: `9` + +*** + +### CREATE\_PERMISSION + +> **CREATE\_PERMISSION**: `8` + +*** + +### DATA + +> **DATA**: `7` + +*** + +### REFRESH + +> **REFRESH**: `4` + +*** + +### SEND + +> **SEND**: `6` + +*** + +### SHARED\_SECRET + +> **SHARED\_SECRET**: `2` diff --git a/packages/ice/doc/functions/candidateFoundation.md b/packages/ice/doc/functions/candidateFoundation.md new file mode 100644 index 000000000..3898835a1 --- /dev/null +++ b/packages/ice/doc/functions/candidateFoundation.md @@ -0,0 +1,21 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / candidateFoundation + +# Function: candidateFoundation() + +> **candidateFoundation**(`candidateType`, `candidateTransport`, `baseAddress`): `string` + +## Parameters + +• **candidateType**: `string` + +• **candidateTransport**: `string` + +• **baseAddress**: `string` + +## Returns + +`string` diff --git a/packages/ice/doc/functions/candidatePairPriority.md b/packages/ice/doc/functions/candidatePairPriority.md new file mode 100644 index 000000000..2bb9207c9 --- /dev/null +++ b/packages/ice/doc/functions/candidatePairPriority.md @@ -0,0 +1,21 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / candidatePairPriority + +# Function: candidatePairPriority() + +> **candidatePairPriority**(`local`, `remote`, `iceControlling`): `number` + +## Parameters + +• **local**: `Pick`\<[`Candidate`](../classes/Candidate.md), `"priority"`\> + +• **remote**: `Pick`\<[`Candidate`](../classes/Candidate.md), `"priority"`\> + +• **iceControlling**: `boolean` + +## Returns + +`number` diff --git a/packages/ice/doc/functions/candidatePriority.md b/packages/ice/doc/functions/candidatePriority.md new file mode 100644 index 000000000..23a60ca6e --- /dev/null +++ b/packages/ice/doc/functions/candidatePriority.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / candidatePriority + +# Function: candidatePriority() + +> **candidatePriority**(`candidateType`, `localPref`): `number` + +## Parameters + +• **candidateType**: `string` + +• **localPref**: `number` = `65535` + +## Returns + +`number` diff --git a/packages/ice/doc/functions/createStunOverTurnClient.md b/packages/ice/doc/functions/createStunOverTurnClient.md new file mode 100644 index 000000000..42dcf86d0 --- /dev/null +++ b/packages/ice/doc/functions/createStunOverTurnClient.md @@ -0,0 +1,37 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / createStunOverTurnClient + +# Function: createStunOverTurnClient() + +> **createStunOverTurnClient**(`__namedParameters`, `__namedParameters`): `Promise`\<[`StunOverTurnProtocol`](../classes/StunOverTurnProtocol.md)\> + +## Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.address**: readonly [`string`, `number`] + +• **\_\_namedParameters.ice**: [`Connection`](../classes/Connection.md) + +• **\_\_namedParameters.password**: `string` + +• **\_\_namedParameters.username**: `string` + +• **\_\_namedParameters** = `{}` + +• **\_\_namedParameters.interfaceAddresses?**: `InterfaceAddresses` + +• **\_\_namedParameters.lifetime?**: `number` + +• **\_\_namedParameters.portRange?**: [`number`, `number`] + +• **\_\_namedParameters.ssl?**: `boolean` + +• **\_\_namedParameters.transport?**: `"udp"` \| `"tcp"` + +## Returns + +`Promise`\<[`StunOverTurnProtocol`](../classes/StunOverTurnProtocol.md)\> diff --git a/packages/ice/doc/functions/createTurnClient.md b/packages/ice/doc/functions/createTurnClient.md new file mode 100644 index 000000000..92e85ab19 --- /dev/null +++ b/packages/ice/doc/functions/createTurnClient.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / createTurnClient + +# Function: createTurnClient() + +> **createTurnClient**(`__namedParameters`, `__namedParameters`): `Promise`\<[`TurnProtocol`](../classes/TurnProtocol.md)\> + +## Parameters + +• **\_\_namedParameters**: [`TurnClientConfig`](../interfaces/TurnClientConfig.md) + +• **\_\_namedParameters**: [`TurnClientOptions`](../interfaces/TurnClientOptions.md) = `{}` + +## Returns + +`Promise`\<[`TurnProtocol`](../classes/TurnProtocol.md)\> diff --git a/packages/ice/doc/functions/getGlobalIp.md b/packages/ice/doc/functions/getGlobalIp.md new file mode 100644 index 000000000..84abb7520 --- /dev/null +++ b/packages/ice/doc/functions/getGlobalIp.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / getGlobalIp + +# Function: getGlobalIp() + +> **getGlobalIp**(`stunServer`?, `interfaceAddresses`?): `Promise`\<`string`\> + +## Parameters + +• **stunServer?**: readonly [`string`, `number`] + +• **interfaceAddresses?**: `InterfaceAddresses` + +## Returns + +`Promise`\<`string`\> diff --git a/packages/ice/doc/functions/getHostAddresses.md b/packages/ice/doc/functions/getHostAddresses.md new file mode 100644 index 000000000..5e8d29ec3 --- /dev/null +++ b/packages/ice/doc/functions/getHostAddresses.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / getHostAddresses + +# Function: getHostAddresses() + +> **getHostAddresses**(`useIpv4`, `useIpv6`): `string`[] + +## Parameters + +• **useIpv4**: `boolean` + +• **useIpv6**: `boolean` + +## Returns + +`string`[] diff --git a/packages/ice/doc/functions/makeIntegrityKey.md b/packages/ice/doc/functions/makeIntegrityKey.md new file mode 100644 index 000000000..89a59c88a --- /dev/null +++ b/packages/ice/doc/functions/makeIntegrityKey.md @@ -0,0 +1,21 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / makeIntegrityKey + +# Function: makeIntegrityKey() + +> **makeIntegrityKey**(`username`, `realm`, `password`): `Buffer` + +## Parameters + +• **username**: `string` + +• **realm**: `string` + +• **password**: `string` + +## Returns + +`Buffer` diff --git a/packages/ice/doc/functions/normalizeFamilyNodeV18.md b/packages/ice/doc/functions/normalizeFamilyNodeV18.md new file mode 100644 index 000000000..a973d35ed --- /dev/null +++ b/packages/ice/doc/functions/normalizeFamilyNodeV18.md @@ -0,0 +1,17 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / normalizeFamilyNodeV18 + +# Function: normalizeFamilyNodeV18() + +> **normalizeFamilyNodeV18**(`family`): `4` \| `6` + +## Parameters + +• **family**: `string` \| `number` + +## Returns + +`4` \| `6` diff --git a/packages/ice/doc/functions/paddingLength.md b/packages/ice/doc/functions/paddingLength.md new file mode 100644 index 000000000..8cfdf02da --- /dev/null +++ b/packages/ice/doc/functions/paddingLength.md @@ -0,0 +1,17 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / paddingLength + +# Function: paddingLength() + +> **paddingLength**(`length`): `number` + +## Parameters + +• **length**: `number` + +## Returns + +`number` diff --git a/packages/ice/doc/functions/parseMessage.md b/packages/ice/doc/functions/parseMessage.md new file mode 100644 index 000000000..d5bfc77ae --- /dev/null +++ b/packages/ice/doc/functions/parseMessage.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / parseMessage + +# Function: parseMessage() + +> **parseMessage**(`data`, `integrityKey`?): [`Message`](../classes/Message.md) \| `undefined` + +## Parameters + +• **data**: `Buffer` + +• **integrityKey?**: `Buffer` + +## Returns + +[`Message`](../classes/Message.md) \| `undefined` diff --git a/packages/ice/doc/functions/randomPort.md b/packages/ice/doc/functions/randomPort.md new file mode 100644 index 000000000..bea5fa943 --- /dev/null +++ b/packages/ice/doc/functions/randomPort.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / randomPort + +# Function: randomPort() + +> **randomPort**(`protocol`, `interfaceAddresses`?): `Promise`\<`number`\> + +## Parameters + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: `InterfaceAddresses` + +## Returns + +`Promise`\<`number`\> diff --git a/packages/ice/doc/functions/serverReflexiveCandidate.md b/packages/ice/doc/functions/serverReflexiveCandidate.md new file mode 100644 index 000000000..4c9ad6c06 --- /dev/null +++ b/packages/ice/doc/functions/serverReflexiveCandidate.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / serverReflexiveCandidate + +# Function: serverReflexiveCandidate() + +> **serverReflexiveCandidate**(`protocol`, `stunServer`): `Promise`\<`undefined` \| [`Candidate`](../classes/Candidate.md)\> + +## Parameters + +• **protocol**: [`Protocol`](../interfaces/Protocol.md) + +• **stunServer**: readonly [`string`, `number`] + +## Returns + +`Promise`\<`undefined` \| [`Candidate`](../classes/Candidate.md)\> diff --git a/packages/ice/doc/functions/sortCandidatePairs.md b/packages/ice/doc/functions/sortCandidatePairs.md new file mode 100644 index 000000000..ad0462a6d --- /dev/null +++ b/packages/ice/doc/functions/sortCandidatePairs.md @@ -0,0 +1,19 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / sortCandidatePairs + +# Function: sortCandidatePairs() + +> **sortCandidatePairs**(`pairs`, `iceControlling`): `object`[] + +## Parameters + +• **pairs**: `object`[] + +• **iceControlling**: `boolean` + +## Returns + +`object`[] diff --git a/packages/ice/doc/functions/url2Address.md b/packages/ice/doc/functions/url2Address.md new file mode 100644 index 000000000..afed9a7d0 --- /dev/null +++ b/packages/ice/doc/functions/url2Address.md @@ -0,0 +1,17 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / url2Address + +# Function: url2Address() + +> **url2Address**(`url`?): `undefined` \| readonly [`string`, `number`] + +## Parameters + +• **url?**: `string` + +## Returns + +`undefined` \| readonly [`string`, `number`] diff --git a/packages/ice/doc/functions/validateAddress.md b/packages/ice/doc/functions/validateAddress.md new file mode 100644 index 000000000..4c4144514 --- /dev/null +++ b/packages/ice/doc/functions/validateAddress.md @@ -0,0 +1,17 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / validateAddress + +# Function: validateAddress() + +> **validateAddress**(`addr`?): [`Address`](../type-aliases/Address.md) \| `undefined` + +## Parameters + +• **addr?**: readonly [`string`, `number`] + +## Returns + +[`Address`](../type-aliases/Address.md) \| `undefined` diff --git a/packages/ice/doc/functions/validateRemoteCandidate.md b/packages/ice/doc/functions/validateRemoteCandidate.md new file mode 100644 index 000000000..824528a4d --- /dev/null +++ b/packages/ice/doc/functions/validateRemoteCandidate.md @@ -0,0 +1,17 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / validateRemoteCandidate + +# Function: validateRemoteCandidate() + +> **validateRemoteCandidate**(`candidate`): [`Candidate`](../classes/Candidate.md) + +## Parameters + +• **candidate**: [`Candidate`](../classes/Candidate.md) + +## Returns + +[`Candidate`](../classes/Candidate.md) diff --git a/packages/ice/doc/globals.md b/packages/ice/doc/globals.md new file mode 100644 index 000000000..c5ad23d0d --- /dev/null +++ b/packages/ice/doc/globals.md @@ -0,0 +1,68 @@ +[**werift-ice**](README.md) • **Docs** + +*** + +# werift-ice + +## Enumerations + +- [CandidatePairState](enumerations/CandidatePairState.md) +- [classes](enumerations/classes.md) +- [methods](enumerations/methods.md) + +## Classes + +- [Candidate](classes/Candidate.md) +- [CandidatePair](classes/CandidatePair.md) +- [Connection](classes/Connection.md) +- [Message](classes/Message.md) +- [StunOverTurnProtocol](classes/StunOverTurnProtocol.md) +- [StunProtocol](classes/StunProtocol.md) +- [TcpTransport](classes/TcpTransport.md) +- [TurnProtocol](classes/TurnProtocol.md) +- [UdpTransport](classes/UdpTransport.md) + +## Interfaces + +- [IceOptions](interfaces/IceOptions.md) +- [Protocol](interfaces/Protocol.md) +- [Transport](interfaces/Transport.md) +- [TurnClientConfig](interfaces/TurnClientConfig.md) +- [TurnClientOptions](interfaces/TurnClientOptions.md) + +## Type Aliases + +- [Address](type-aliases/Address.md) + +## Variables + +- [AttributeKeys](variables/AttributeKeys.md) +- [COOKIE](variables/COOKIE.md) +- [FINGERPRINT\_LENGTH](variables/FINGERPRINT_LENGTH.md) +- [FINGERPRINT\_XOR](variables/FINGERPRINT_XOR.md) +- [HEADER\_LENGTH](variables/HEADER_LENGTH.md) +- [INTEGRITY\_LENGTH](variables/INTEGRITY_LENGTH.md) +- [IPV4\_PROTOCOL](variables/IPV4_PROTOCOL.md) +- [IPV6\_PROTOCOL](variables/IPV6_PROTOCOL.md) +- [RETRY\_MAX](variables/RETRY_MAX.md) +- [RETRY\_RTO](variables/RETRY_RTO.md) + +## Functions + +- [candidateFoundation](functions/candidateFoundation.md) +- [candidatePairPriority](functions/candidatePairPriority.md) +- [candidatePriority](functions/candidatePriority.md) +- [createStunOverTurnClient](functions/createStunOverTurnClient.md) +- [createTurnClient](functions/createTurnClient.md) +- [getGlobalIp](functions/getGlobalIp.md) +- [getHostAddresses](functions/getHostAddresses.md) +- [makeIntegrityKey](functions/makeIntegrityKey.md) +- [normalizeFamilyNodeV18](functions/normalizeFamilyNodeV18.md) +- [paddingLength](functions/paddingLength.md) +- [parseMessage](functions/parseMessage.md) +- [randomPort](functions/randomPort.md) +- [serverReflexiveCandidate](functions/serverReflexiveCandidate.md) +- [sortCandidatePairs](functions/sortCandidatePairs.md) +- [url2Address](functions/url2Address.md) +- [validateAddress](functions/validateAddress.md) +- [validateRemoteCandidate](functions/validateRemoteCandidate.md) diff --git a/packages/ice/doc/interfaces/IceOptions.md b/packages/ice/doc/interfaces/IceOptions.md new file mode 100644 index 000000000..f3f528ac1 --- /dev/null +++ b/packages/ice/doc/interfaces/IceOptions.md @@ -0,0 +1,111 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / IceOptions + +# Interface: IceOptions + +## Properties + +### additionalHostAddresses? + +> `optional` **additionalHostAddresses**: `string`[] + +*** + +### filterCandidatePair()? + +> `optional` **filterCandidatePair**: (`pair`) => `boolean` + +#### Parameters + +• **pair**: [`CandidatePair`](../classes/CandidatePair.md) + +#### Returns + +`boolean` + +*** + +### filterStunResponse()? + +> `optional` **filterStunResponse**: (`message`, `addr`, `protocol`) => `boolean` + +#### Parameters + +• **message**: [`Message`](../classes/Message.md) + +• **addr**: readonly [`string`, `number`] + +• **protocol**: [`Protocol`](Protocol.md) + +#### Returns + +`boolean` + +*** + +### forceTurn? + +> `optional` **forceTurn**: `boolean` + +*** + +### interfaceAddresses? + +> `optional` **interfaceAddresses**: `InterfaceAddresses` + +*** + +### portRange? + +> `optional` **portRange**: [`number`, `number`] + +*** + +### stunServer? + +> `optional` **stunServer**: readonly [`string`, `number`] + +*** + +### turnPassword? + +> `optional` **turnPassword**: `string` + +*** + +### turnServer? + +> `optional` **turnServer**: readonly [`string`, `number`] + +*** + +### turnSsl? + +> `optional` **turnSsl**: `boolean` + +*** + +### turnTransport? + +> `optional` **turnTransport**: `string` + +*** + +### turnUsername? + +> `optional` **turnUsername**: `string` + +*** + +### useIpv4 + +> **useIpv4**: `boolean` + +*** + +### useIpv6 + +> **useIpv6**: `boolean` diff --git a/packages/ice/doc/interfaces/Protocol.md b/packages/ice/doc/interfaces/Protocol.md new file mode 100644 index 000000000..7bef6be0e --- /dev/null +++ b/packages/ice/doc/interfaces/Protocol.md @@ -0,0 +1,113 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Protocol + +# Interface: Protocol + +## Properties + +### close() + +> **close**: () => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### connectionMade() + +> **connectionMade**: (...`args`) => `Promise`\<`void`\> + +#### Parameters + +• ...**args**: `any` + +#### Returns + +`Promise`\<`void`\> + +*** + +### localCandidate? + +> `optional` **localCandidate**: [`Candidate`](../classes/Candidate.md) + +*** + +### request() + +> **request**: (`message`, `addr`, `integrityKey`?, `retransmissions`?) => `Promise`\<[[`Message`](../classes/Message.md), readonly [`string`, `number`]]\> + +#### Parameters + +• **message**: [`Message`](../classes/Message.md) + +• **addr**: readonly [`string`, `number`] + +• **integrityKey?**: `Buffer` + +• **retransmissions?**: `any` + +#### Returns + +`Promise`\<[[`Message`](../classes/Message.md), readonly [`string`, `number`]]\> + +*** + +### responseAddr? + +> `optional` **responseAddr**: readonly [`string`, `number`] + +*** + +### responseMessage? + +> `optional` **responseMessage**: `string` + +*** + +### sendData() + +> **sendData**: (`data`, `addr`) => `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### sendStun() + +> **sendStun**: (`message`, `addr`) => `Promise`\<`void`\> + +#### Parameters + +• **message**: [`Message`](../classes/Message.md) + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### sentMessage? + +> `optional` **sentMessage**: [`Message`](../classes/Message.md) + +*** + +### type + +> **type**: `string` diff --git a/packages/ice/doc/interfaces/Transport.md b/packages/ice/doc/interfaces/Transport.md new file mode 100644 index 000000000..6db79d628 --- /dev/null +++ b/packages/ice/doc/interfaces/Transport.md @@ -0,0 +1,55 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Transport + +# Interface: Transport + +## Properties + +### close() + +> **close**: () => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### onData() + +> **onData**: (`data`, `addr`) => `void` + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`void` + +*** + +### send() + +> **send**: (`data`, `addr`) => `Promise`\<`void`\> + +#### Parameters + +• **data**: `Buffer` + +• **addr**: readonly [`string`, `number`] + +#### Returns + +`Promise`\<`void`\> + +*** + +### type + +> **type**: `string` diff --git a/packages/ice/doc/interfaces/TurnClientConfig.md b/packages/ice/doc/interfaces/TurnClientConfig.md new file mode 100644 index 000000000..ddf66b112 --- /dev/null +++ b/packages/ice/doc/interfaces/TurnClientConfig.md @@ -0,0 +1,25 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / TurnClientConfig + +# Interface: TurnClientConfig + +## Properties + +### address + +> **address**: readonly [`string`, `number`] + +*** + +### password + +> **password**: `string` + +*** + +### username + +> **username**: `string` diff --git a/packages/ice/doc/interfaces/TurnClientOptions.md b/packages/ice/doc/interfaces/TurnClientOptions.md new file mode 100644 index 000000000..6098116dc --- /dev/null +++ b/packages/ice/doc/interfaces/TurnClientOptions.md @@ -0,0 +1,37 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / TurnClientOptions + +# Interface: TurnClientOptions + +## Properties + +### interfaceAddresses? + +> `optional` **interfaceAddresses**: `InterfaceAddresses` + +*** + +### lifetime? + +> `optional` **lifetime**: `number` + +*** + +### portRange? + +> `optional` **portRange**: [`number`, `number`] + +*** + +### ssl? + +> `optional` **ssl**: `boolean` + +*** + +### transport? + +> `optional` **transport**: `"udp"` \| `"tcp"` diff --git a/packages/ice/doc/type-aliases/Address.md b/packages/ice/doc/type-aliases/Address.md new file mode 100644 index 000000000..596a4d336 --- /dev/null +++ b/packages/ice/doc/type-aliases/Address.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / Address + +# Type Alias: Address + +> **Address**: `Readonly`\<[`string`, `number`]\> diff --git a/packages/ice/doc/variables/AttributeKeys.md b/packages/ice/doc/variables/AttributeKeys.md new file mode 100644 index 000000000..3fd188798 --- /dev/null +++ b/packages/ice/doc/variables/AttributeKeys.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / AttributeKeys + +# Variable: AttributeKeys + +> `const` **AttributeKeys**: readonly [`"FINGERPRINT"`, `"MESSAGE-INTEGRITY"`, `"CHANGE-REQUEST"`, `"PRIORITY"`, `"USERNAME"`, `"ICE-CONTROLLING"`, `"SOURCE-ADDRESS"`, `"USE-CANDIDATE"`, `"ICE-CONTROLLED"`, `"ERROR-CODE"`, `"XOR-MAPPED-ADDRESS"`, `"CHANGED-ADDRESS"`, `"LIFETIME"`, `"REQUESTED-TRANSPORT"`, `"NONCE"`, `"REALM"`, `"XOR-RELAYED-ADDRESS"`, `"CHANNEL-NUMBER"`, `"XOR-PEER-ADDRESS"`, `"DATA"`, `"SOFTWARE"`, `"MAPPED-ADDRESS"`, `"RESPONSE-ORIGIN"`, `"OTHER-ADDRESS"`] diff --git a/packages/ice/doc/variables/COOKIE.md b/packages/ice/doc/variables/COOKIE.md new file mode 100644 index 000000000..954e96d7a --- /dev/null +++ b/packages/ice/doc/variables/COOKIE.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / COOKIE + +# Variable: COOKIE + +> `const` **COOKIE**: `554869826` = `0x2112a442` diff --git a/packages/ice/doc/variables/FINGERPRINT_LENGTH.md b/packages/ice/doc/variables/FINGERPRINT_LENGTH.md new file mode 100644 index 000000000..0dda29358 --- /dev/null +++ b/packages/ice/doc/variables/FINGERPRINT_LENGTH.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / FINGERPRINT\_LENGTH + +# Variable: FINGERPRINT\_LENGTH + +> `const` **FINGERPRINT\_LENGTH**: `8` = `8` diff --git a/packages/ice/doc/variables/FINGERPRINT_XOR.md b/packages/ice/doc/variables/FINGERPRINT_XOR.md new file mode 100644 index 000000000..a81451f4f --- /dev/null +++ b/packages/ice/doc/variables/FINGERPRINT_XOR.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / FINGERPRINT\_XOR + +# Variable: FINGERPRINT\_XOR + +> `const` **FINGERPRINT\_XOR**: `1398035790` = `0x5354554e` diff --git a/packages/ice/doc/variables/HEADER_LENGTH.md b/packages/ice/doc/variables/HEADER_LENGTH.md new file mode 100644 index 000000000..c9df39806 --- /dev/null +++ b/packages/ice/doc/variables/HEADER_LENGTH.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / HEADER\_LENGTH + +# Variable: HEADER\_LENGTH + +> `const` **HEADER\_LENGTH**: `20` = `20` diff --git a/packages/ice/doc/variables/INTEGRITY_LENGTH.md b/packages/ice/doc/variables/INTEGRITY_LENGTH.md new file mode 100644 index 000000000..e58bdcbb5 --- /dev/null +++ b/packages/ice/doc/variables/INTEGRITY_LENGTH.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / INTEGRITY\_LENGTH + +# Variable: INTEGRITY\_LENGTH + +> `const` **INTEGRITY\_LENGTH**: `24` = `24` diff --git a/packages/ice/doc/variables/IPV4_PROTOCOL.md b/packages/ice/doc/variables/IPV4_PROTOCOL.md new file mode 100644 index 000000000..70c962640 --- /dev/null +++ b/packages/ice/doc/variables/IPV4_PROTOCOL.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / IPV4\_PROTOCOL + +# Variable: IPV4\_PROTOCOL + +> `const` **IPV4\_PROTOCOL**: `1` = `1` diff --git a/packages/ice/doc/variables/IPV6_PROTOCOL.md b/packages/ice/doc/variables/IPV6_PROTOCOL.md new file mode 100644 index 000000000..592153da9 --- /dev/null +++ b/packages/ice/doc/variables/IPV6_PROTOCOL.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / IPV6\_PROTOCOL + +# Variable: IPV6\_PROTOCOL + +> `const` **IPV6\_PROTOCOL**: `2` = `2` diff --git a/packages/ice/doc/variables/RETRY_MAX.md b/packages/ice/doc/variables/RETRY_MAX.md new file mode 100644 index 000000000..9ace769ea --- /dev/null +++ b/packages/ice/doc/variables/RETRY_MAX.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / RETRY\_MAX + +# Variable: RETRY\_MAX + +> `const` **RETRY\_MAX**: `6` = `6` diff --git a/packages/ice/doc/variables/RETRY_RTO.md b/packages/ice/doc/variables/RETRY_RTO.md new file mode 100644 index 000000000..3e3302709 --- /dev/null +++ b/packages/ice/doc/variables/RETRY_RTO.md @@ -0,0 +1,9 @@ +[**werift-ice**](../README.md) • **Docs** + +*** + +[werift-ice](../globals.md) / RETRY\_RTO + +# Variable: RETRY\_RTO + +> `const` **RETRY\_RTO**: `50` = `50` diff --git a/packages/ice/package.json b/packages/ice/package.json index 1f0721577..60b38bd7a 100644 --- a/packages/ice/package.json +++ b/packages/ice/package.json @@ -21,6 +21,7 @@ "build": "npm run format && tsc -p ./tsconfig.production.json", "deploy": "npm run build && npm publish", "deploy:alpha": "npm run build && npm publish --tag alpha", + "doc": "rm -rf doc && typedoc --excludePrivate --disableSources --excludeInternal --plugin typedoc-plugin-markdown --out doc ./src/index.ts", "format": "biome check --write src tests examples", "start": "ts-node --project ./tsconfig.json ./example/cli/index.ts", "test": "vitest run ./tests", @@ -29,11 +30,11 @@ "upgrade-interactive": "npx npm-check-updates -i" }, "dependencies": { + "@shinyoshiaki/jspack": "^0.0.6", "buffer-crc32": "^1.0.0", "debug": "^4.3.4", "int64-buffer": "^1.0.1", "ip": "^2.0.1", - "@shinyoshiaki/jspack": "^0.0.6", "lodash": "^4.17.21", "multicast-dns": "^7.2.5", "p-cancelable": "^2.1.1", diff --git a/packages/rtp/doc/.nojekyll b/packages/rtp/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/packages/rtp/doc/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/rtp/doc/README.md b/packages/rtp/doc/README.md index 732ff8870..8ad1e0b1a 100644 --- a/packages/rtp/doc/README.md +++ b/packages/rtp/doc/README.md @@ -1,4 +1,6 @@ -werift-rtp / [Exports](modules.md) +**werift-rtp** • [**Docs**](globals.md) + +*** # werift-rtp diff --git a/packages/rtp/doc/classes/AV1Obu.md b/packages/rtp/doc/classes/AV1Obu.md index 93add1750..44aad92b2 100644 --- a/packages/rtp/doc/classes/AV1Obu.md +++ b/packages/rtp/doc/classes/AV1Obu.md @@ -1,32 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / AV1Obu +[**werift-rtp**](../README.md) • **Docs** -# Class: AV1Obu - -## Table of contents - -### Constructors - -- [constructor](AV1Obu.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / AV1Obu -- [obu\_extension\_flag](AV1Obu.md#obu_extension_flag) -- [obu\_forbidden\_bit](AV1Obu.md#obu_forbidden_bit) -- [obu\_has\_size\_field](AV1Obu.md#obu_has_size_field) -- [obu\_reserved\_1bit](AV1Obu.md#obu_reserved_1bit) -- [obu\_type](AV1Obu.md#obu_type) -- [payload](AV1Obu.md#payload) - -### Methods - -- [serialize](AV1Obu.md#serialize) -- [deSerialize](AV1Obu.md#deserialize) +# Class: AV1Obu ## Constructors -### constructor +### new AV1Obu() -• **new AV1Obu**(): [`AV1Obu`](AV1Obu.md) +> **new AV1Obu**(): [`AV1Obu`](AV1Obu.md) #### Returns @@ -36,59 +20,57 @@ ### obu\_extension\_flag -• **obu\_extension\_flag**: `number` +> **obu\_extension\_flag**: `number` -___ +*** ### obu\_forbidden\_bit -• **obu\_forbidden\_bit**: `number` +> **obu\_forbidden\_bit**: `number` -___ +*** ### obu\_has\_size\_field -• **obu\_has\_size\_field**: `number` +> **obu\_has\_size\_field**: `number` -___ +*** ### obu\_reserved\_1bit -• **obu\_reserved\_1bit**: `number` +> **obu\_reserved\_1bit**: `number` -___ +*** ### obu\_type -• **obu\_type**: `OBU_TYPE` +> **obu\_type**: `OBU_TYPE` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md) +> `static` **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/AV1RtpPayload.md b/packages/rtp/doc/classes/AV1RtpPayload.md index 8040538b4..b84fd9fe0 100644 --- a/packages/rtp/doc/classes/AV1RtpPayload.md +++ b/packages/rtp/doc/classes/AV1RtpPayload.md @@ -1,36 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / AV1RtpPayload +[**werift-rtp**](../README.md) • **Docs** -# Class: AV1RtpPayload - -## Table of contents - -### Constructors - -- [constructor](AV1RtpPayload.md#constructor) - -### Properties +*** -- [nBit\_RtpStartsNewCodedVideoSequence](AV1RtpPayload.md#nbit_rtpstartsnewcodedvideosequence) -- [obu\_or\_fragment](AV1RtpPayload.md#obu_or_fragment) -- [w\_RtpNumObus](AV1RtpPayload.md#w_rtpnumobus) -- [yBit\_RtpEndsWithFragment](AV1RtpPayload.md#ybit_rtpendswithfragment) -- [zBit\_RtpStartsWithFragment](AV1RtpPayload.md#zbit_rtpstartswithfragment) +[werift-rtp](../globals.md) / AV1RtpPayload -### Accessors - -- [isKeyframe](AV1RtpPayload.md#iskeyframe) - -### Methods - -- [deSerialize](AV1RtpPayload.md#deserialize) -- [getFrame](AV1RtpPayload.md#getframe) -- [isDetectedFinalPacketInSequence](AV1RtpPayload.md#isdetectedfinalpacketinsequence) +# Class: AV1RtpPayload ## Constructors -### constructor +### new AV1RtpPayload() -• **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md) +> **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md) #### Returns @@ -40,40 +20,40 @@ ### nBit\_RtpStartsNewCodedVideoSequence -• **nBit\_RtpStartsNewCodedVideoSequence**: `number` +> **nBit\_RtpStartsNewCodedVideoSequence**: `number` RtpStartsNewCodedVideoSequence MUST be set to 1 if the packet is the first packet of a coded video sequence, and MUST be set to 0 otherwise. -___ +*** ### obu\_or\_fragment -• **obu\_or\_fragment**: \{ `data`: `Buffer` ; `isFragment`: `boolean` }[] = `[]` +> **obu\_or\_fragment**: `object`[] = `[]` -___ +*** ### w\_RtpNumObus -• **w\_RtpNumObus**: `number` +> **w\_RtpNumObus**: `number` RtpNumObus two bit field that describes the number of OBU elements in the packet. This field MUST be set equal to 0 or equal to the number of OBU elements contained in the packet. If set to 0, each OBU element MUST be preceded by a length field. -___ +*** ### yBit\_RtpEndsWithFragment -• **yBit\_RtpEndsWithFragment**: `number` +> **yBit\_RtpEndsWithFragment**: `number` RtpEndsWithFragment MUST be set to 1 if the last OBU element is an OBU fragment that will continue in the next packet, and MUST be set to 0 otherwise. -___ +*** ### zBit\_RtpStartsWithFragment -• **zBit\_RtpStartsWithFragment**: `number` +> **zBit\_RtpStartsWithFragment**: `number` RtpStartsWithFragment MUST be set to 1 if the first OBU element is an OBU fragment that is a continuation of an OBU fragment from the previous packet, and MUST be set to 0 otherwise. @@ -82,7 +62,7 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -90,47 +70,41 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md) +> `static` **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`AV1RtpPayload`](AV1RtpPayload.md) -___ +*** -### getFrame +### getFrame() -▸ **getFrame**(`payloads`): `Buffer` +> `static` **getFrame**(`payloads`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `payloads` | [`AV1RtpPayload`](AV1RtpPayload.md)[] | +• **payloads**: [`AV1RtpPayload`](AV1RtpPayload.md)[] #### Returns `Buffer` -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/BitStream.md b/packages/rtp/doc/classes/BitStream.md index 8e6208b12..6ec2bafec 100644 --- a/packages/rtp/doc/classes/BitStream.md +++ b/packages/rtp/doc/classes/BitStream.md @@ -1,34 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / BitStream +[**werift-rtp**](../README.md) • **Docs** -# Class: BitStream - -## Table of contents - -### Constructors - -- [constructor](BitStream.md#constructor) - -### Properties - -- [uint8Array](BitStream.md#uint8array) +*** -### Methods +[werift-rtp](../globals.md) / BitStream -- [readBits](BitStream.md#readbits) -- [seekTo](BitStream.md#seekto) -- [writeBits](BitStream.md#writebits) +# Class: BitStream ## Constructors -### constructor +### new BitStream() -• **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md) +> **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `uint8Array` | `Buffer` | +• **uint8Array**: `Buffer` #### Returns @@ -38,53 +24,49 @@ ### uint8Array -• **uint8Array**: `Buffer` +> **uint8Array**: `Buffer` ## Methods -### readBits +### readBits() -▸ **readBits**(`bits`, `bitBuffer?`): `any` +> **readBits**(`bits`, `bitBuffer`?): `any` #### Parameters -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `bitBuffer?` | `number` | +• **bits**: `number` + +• **bitBuffer?**: `number` #### Returns `any` -___ +*** -### seekTo +### seekTo() -▸ **seekTo**(`bitPos`): `void` +> **seekTo**(`bitPos`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `bitPos` | `number` | +• **bitPos**: `number` #### Returns `void` -___ +*** -### writeBits +### writeBits() -▸ **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md) +> **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `value` | `number` | +• **bits**: `number` + +• **value**: `number` #### Returns diff --git a/packages/rtp/doc/classes/BitWriter.md b/packages/rtp/doc/classes/BitWriter.md index b55b74a6d..c1e820c45 100644 --- a/packages/rtp/doc/classes/BitWriter.md +++ b/packages/rtp/doc/classes/BitWriter.md @@ -1,36 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / BitWriter +[**werift-rtp**](../README.md) • **Docs** -# Class: BitWriter - -## Table of contents - -### Constructors - -- [constructor](BitWriter.md#constructor) - -### Properties - -- [value](BitWriter.md#value) +*** -### Accessors +[werift-rtp](../globals.md) / BitWriter -- [buffer](BitWriter.md#buffer) - -### Methods - -- [set](BitWriter.md#set) +# Class: BitWriter ## Constructors -### constructor +### new BitWriter() -• **new BitWriter**(`bitLength`): [`BitWriter`](BitWriter.md) +> **new BitWriter**(`bitLength`): [`BitWriter`](BitWriter.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bitLength` | `number` | +• **bitLength**: `number` #### Returns @@ -40,13 +24,13 @@ ### value -• **value**: `number` = `0` +> **value**: `number` = `0` ## Accessors ### buffer -• `get` **buffer**(): `Buffer` +> `get` **buffer**(): `Buffer` #### Returns @@ -54,17 +38,17 @@ ## Methods -### set +### set() -▸ **set**(`size`, `startIndex`, `value`): [`BitWriter`](BitWriter.md) +> **set**(`size`, `startIndex`, `value`): [`BitWriter`](BitWriter.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | -| `startIndex` | `number` | -| `value` | `number` | +• **size**: `number` + +• **startIndex**: `number` + +• **value**: `number` #### Returns diff --git a/packages/rtp/doc/classes/BitWriter2.md b/packages/rtp/doc/classes/BitWriter2.md index 911baffbe..ab6583043 100644 --- a/packages/rtp/doc/classes/BitWriter2.md +++ b/packages/rtp/doc/classes/BitWriter2.md @@ -1,39 +1,24 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / BitWriter2 +[**werift-rtp**](../README.md) • **Docs** -# Class: BitWriter2 - -## Table of contents - -### Constructors - -- [constructor](BitWriter2.md#constructor) - -### Properties - -- [offset](BitWriter2.md#offset) +*** -### Accessors +[werift-rtp](../globals.md) / BitWriter2 -- [buffer](BitWriter2.md#buffer) -- [value](BitWriter2.md#value) - -### Methods - -- [set](BitWriter2.md#set) +# Class: BitWriter2 ## Constructors -### constructor +### new BitWriter2() -• **new BitWriter2**(`bitLength`): [`BitWriter2`](BitWriter2.md) +> **new BitWriter2**(`bitLength`): [`BitWriter2`](BitWriter2.md) 各valueがオクテットを跨いではならない #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `bitLength` | `number` | Max 32bit | +• **bitLength**: `number` + +Max 32bit #### Returns @@ -43,23 +28,23 @@ ### offset -• **offset**: `bigint` +> **offset**: `bigint` ## Accessors ### buffer -• `get` **buffer**(): `Buffer` +> `get` **buffer**(): `Buffer` #### Returns `Buffer` -___ +*** ### value -• `get` **value**(): `number` +> `get` **value**(): `number` #### Returns @@ -67,16 +52,15 @@ ___ ## Methods -### set +### set() -▸ **set**(`value`, `size?`): [`BitWriter2`](BitWriter2.md) +> **set**(`value`, `size`): [`BitWriter2`](BitWriter2.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `value` | `number` | `undefined` | -| `size` | `number` | `1` | +• **value**: `number` + +• **size**: `number` = `1` #### Returns diff --git a/packages/rtp/doc/classes/BufferChain.md b/packages/rtp/doc/classes/BufferChain.md index 5fee9eac1..36a083e64 100644 --- a/packages/rtp/doc/classes/BufferChain.md +++ b/packages/rtp/doc/classes/BufferChain.md @@ -1,33 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / BufferChain +[**werift-rtp**](../README.md) • **Docs** -# Class: BufferChain - -## Table of contents - -### Constructors - -- [constructor](BufferChain.md#constructor) - -### Properties +*** -- [buffer](BufferChain.md#buffer) +[werift-rtp](../globals.md) / BufferChain -### Methods - -- [writeInt16BE](BufferChain.md#writeint16be) -- [writeUInt8](BufferChain.md#writeuint8) +# Class: BufferChain ## Constructors -### constructor +### new BufferChain() -• **new BufferChain**(`size`): [`BufferChain`](BufferChain.md) +> **new BufferChain**(`size`): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | +• **size**: `number` #### Returns @@ -37,37 +24,35 @@ ### buffer -• **buffer**: `Buffer` +> **buffer**: `Buffer` ## Methods -### writeInt16BE +### writeInt16BE() -▸ **writeInt16BE**(`value`, `offset?`): [`BufferChain`](BufferChain.md) +> **writeInt16BE**(`value`, `offset`?): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | `number` | -| `offset?` | `number` | +• **value**: `number` + +• **offset?**: `number` #### Returns [`BufferChain`](BufferChain.md) -___ +*** -### writeUInt8 +### writeUInt8() -▸ **writeUInt8**(`value`, `offset?`): [`BufferChain`](BufferChain.md) +> **writeUInt8**(`value`, `offset`?): [`BufferChain`](BufferChain.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | `number` | -| `offset?` | `number` | +• **value**: `number` + +• **offset?**: `number` #### Returns diff --git a/packages/rtp/doc/classes/DePacketizerBase.md b/packages/rtp/doc/classes/DePacketizerBase.md index bea59384c..8695b4943 100644 --- a/packages/rtp/doc/classes/DePacketizerBase.md +++ b/packages/rtp/doc/classes/DePacketizerBase.md @@ -1,39 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / DePacketizerBase +[**werift-rtp**](../README.md) • **Docs** -# Class: DePacketizerBase +*** -## Implemented by +[werift-rtp](../globals.md) / DePacketizerBase -- [`H264RtpPayload`](H264RtpPayload.md) -- [`OpusRtpPayload`](OpusRtpPayload.md) -- [`Vp8RtpPayload`](Vp8RtpPayload.md) -- [`Vp9RtpPayload`](Vp9RtpPayload.md) - -## Table of contents - -### Constructors - -- [constructor](DePacketizerBase.md#constructor) - -### Properties - -- [fragment](DePacketizerBase.md#fragment) -- [payload](DePacketizerBase.md#payload) - -### Accessors - -- [isKeyframe](DePacketizerBase.md#iskeyframe) - -### Methods - -- [deSerialize](DePacketizerBase.md#deserialize) -- [isDetectedFinalPacketInSequence](DePacketizerBase.md#isdetectedfinalpacketinsequence) +# Class: `abstract` DePacketizerBase ## Constructors -### constructor +### new DePacketizerBase() -• **new DePacketizerBase**(): [`DePacketizerBase`](DePacketizerBase.md) +> **new DePacketizerBase**(): [`DePacketizerBase`](DePacketizerBase.md) #### Returns @@ -41,21 +18,21 @@ ## Properties -### fragment +### fragment? -• `Optional` **fragment**: `Buffer` +> `optional` **fragment**: `Buffer` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -63,32 +40,29 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`, `fragment?`): [`DePacketizerBase`](DePacketizerBase.md) +> `static` **deSerialize**(`buf`, `fragment`?): [`DePacketizerBase`](DePacketizerBase.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `fragment?` | `Buffer` | +• **buf**: `Buffer` + +• **fragment?**: `Buffer` #### Returns [`DePacketizerBase`](DePacketizerBase.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/Event.md b/packages/rtp/doc/classes/Event.md new file mode 100644 index 000000000..186ae1523 --- /dev/null +++ b/packages/rtp/doc/classes/Event.md @@ -0,0 +1,349 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / Event + +# Class: Event\ + +## Type Parameters + +• **T** *extends* `any`[] + +## Constructors + +### new Event() + +> **new Event**\<`T`\>(): [`Event`](Event.md)\<`T`\> + +#### Returns + +[`Event`](Event.md)\<`T`\> + +## Properties + +### ended + +> **ended**: `boolean` = `false` + +*** + +### onended()? + +> `optional` **onended**: () => `void` + +#### Returns + +`void` + +## Accessors + +### length + +> `get` **length**(): `number` + +#### Returns + +`number` + +*** + +### returnListener + +> `get` **returnListener**(): `object` + +#### Returns + +`object` + +##### asPromise() + +> **asPromise**: (`timeLimit`?) => `Promise`\<`T`\> + +###### Parameters + +• **timeLimit?**: `number` + +###### Returns + +`Promise`\<`T`\> + +##### once() + +> **once**: (`execute`, `complete`?, `error`?) => `void` + +###### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +###### Returns + +`void` + +##### subscribe() + +> **subscribe**: (`execute`, `complete`?, `error`?) => `object` + +###### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +###### Returns + +`object` + +###### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +###### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### returnTrigger + +> `get` **returnTrigger**(): `object` + +#### Returns + +`object` + +##### complete() + +> **complete**: () => `void` + +###### Returns + +`void` + +##### error() + +> **error**: (`e`) => `void` + +###### Parameters + +• **e**: `any` + +###### Returns + +`void` + +##### execute() + +> **execute**: (...`args`) => `void` + +###### Parameters + +• ...**args**: `T` + +###### Returns + +`void` + +## Methods + +### allUnsubscribe() + +> **allUnsubscribe**(): `void` + +#### Returns + +`void` + +*** + +### asPromise() + +> **asPromise**(`timeLimit`?): `Promise`\<`T`\> + +#### Parameters + +• **timeLimit?**: `number` + +#### Returns + +`Promise`\<`T`\> + +*** + +### complete() + +> **complete**(): `void` + +#### Returns + +`void` + +*** + +### error() + +> **error**(`e`): `void` + +#### Parameters + +• **e**: `any` + +#### Returns + +`void` + +*** + +### execute() + +> **execute**(...`args`): `void` + +#### Parameters + +• ...**args**: `T` + +#### Returns + +`void` + +*** + +### once() + +> **once**(`execute`, `complete`?, `error`?): `void` + +#### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`void` + +*** + +### onerror() + +> **onerror**(`e`): `void` + +#### Parameters + +• **e**: `any` + +#### Returns + +`void` + +*** + +### queuingSubscribe() + +> **queuingSubscribe**(`execute`, `complete`?, `error`?): `object` + +#### Parameters + +• **execute**: `PromiseEventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`object` + +##### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +##### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### subscribe() + +> **subscribe**(`execute`, `complete`?, `error`?): `object` + +#### Parameters + +• **execute**: `EventExecute`\<`T`\> + +• **complete?**: `EventComplete` + +• **error?**: `EventError` + +#### Returns + +`object` + +##### disposer() + +> **disposer**: (`disposer`) => `void` + +###### Parameters + +• **disposer**: [`EventDisposer`](EventDisposer.md) + +###### Returns + +`void` + +##### unSubscribe() + +> **unSubscribe**: () => `void` + +###### Returns + +`void` + +*** + +### watch() + +> **watch**(`cb`, `timeLimit`?): `Promise`\<`T`\> + +#### Parameters + +• **cb** + +• **timeLimit?**: `number` + +#### Returns + +`Promise`\<`T`\> diff --git a/packages/rtp/doc/classes/EventDisposer.md b/packages/rtp/doc/classes/EventDisposer.md new file mode 100644 index 000000000..3a67a768b --- /dev/null +++ b/packages/rtp/doc/classes/EventDisposer.md @@ -0,0 +1,41 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / EventDisposer + +# Class: EventDisposer + +## Constructors + +### new EventDisposer() + +> **new EventDisposer**(): [`EventDisposer`](EventDisposer.md) + +#### Returns + +[`EventDisposer`](EventDisposer.md) + +## Methods + +### dispose() + +> **dispose**(): `void` + +#### Returns + +`void` + +*** + +### push() + +> **push**(`disposer`): `void` + +#### Parameters + +• **disposer** + +#### Returns + +`void` diff --git a/packages/rtp/doc/classes/GenericNack.md b/packages/rtp/doc/classes/GenericNack.md index 1ab81200b..31fb70172 100644 --- a/packages/rtp/doc/classes/GenericNack.md +++ b/packages/rtp/doc/classes/GenericNack.md @@ -1,39 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / GenericNack +[**werift-rtp**](../README.md) • **Docs** -# Class: GenericNack - -## Table of contents - -### Constructors - -- [constructor](GenericNack.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / GenericNack -- [count](GenericNack.md#count) -- [header](GenericNack.md#header) -- [lost](GenericNack.md#lost) -- [mediaSourceSsrc](GenericNack.md#mediasourcessrc) -- [senderSsrc](GenericNack.md#senderssrc) -- [count](GenericNack.md#count-1) - -### Methods - -- [serialize](GenericNack.md#serialize) -- [toJSON](GenericNack.md#tojson) -- [deSerialize](GenericNack.md#deserialize) +# Class: GenericNack ## Constructors -### constructor +### new GenericNack() -• **new GenericNack**(`props?`): [`GenericNack`](GenericNack.md) +> **new GenericNack**(`props`): [`GenericNack`](GenericNack.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`GenericNack`](GenericNack.md)\> | +• **props**: `Partial`\<[`GenericNack`](GenericNack.md)\> = `{}` #### Returns @@ -43,76 +24,81 @@ ### count -• `Readonly` **count**: `number` = `GenericNack.count` +> `readonly` **count**: `number` = `GenericNack.count` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### lost -• **lost**: `number`[] = `[]` +> **lost**: `number`[] = `[]` -___ +*** ### mediaSourceSsrc -• **mediaSourceSsrc**: `number` +> **mediaSourceSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `1` +> `static` **count**: `number` = `1` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` -| Name | Type | -| :------ | :------ | -| `lost` | `number`[] | -| `mediaSourceSsrc` | `number` | -| `senderSsrc` | `number` | +##### lost -___ +> **lost**: `number`[] -### deSerialize +##### mediaSourceSsrc -▸ **deSerialize**(`data`, `header`): [`GenericNack`](GenericNack.md) +> **mediaSourceSsrc**: `number` + +##### senderSsrc + +> **senderSsrc**: `number` + +*** + +### deSerialize() + +> `static` **deSerialize**(`data`, `header`): [`GenericNack`](GenericNack.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/H264RtpPayload.md b/packages/rtp/doc/classes/H264RtpPayload.md index a201a60b3..f220679be 100644 --- a/packages/rtp/doc/classes/H264RtpPayload.md +++ b/packages/rtp/doc/classes/H264RtpPayload.md @@ -1,4 +1,8 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / H264RtpPayload +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / H264RtpPayload # Class: H264RtpPayload @@ -6,39 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](H264RtpPayload.md#constructor) - -### Properties - -- [e](H264RtpPayload.md#e) -- [f](H264RtpPayload.md#f) -- [fragment](H264RtpPayload.md#fragment) -- [nalUnitPayloadType](H264RtpPayload.md#nalunitpayloadtype) -- [nalUnitType](H264RtpPayload.md#nalunittype) -- [nri](H264RtpPayload.md#nri) -- [payload](H264RtpPayload.md#payload) -- [r](H264RtpPayload.md#r) -- [s](H264RtpPayload.md#s) - -### Accessors - -- [isKeyframe](H264RtpPayload.md#iskeyframe) -- [isPartitionHead](H264RtpPayload.md#ispartitionhead) - -### Methods - -- [deSerialize](H264RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](H264RtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new H264RtpPayload() -• **new H264RtpPayload**(): [`H264RtpPayload`](H264RtpPayload.md) +> **new H264RtpPayload**(): [`H264RtpPayload`](H264RtpPayload.md) #### Returns @@ -48,71 +24,71 @@ ### e -• **e**: `number` +> **e**: `number` end of a fragmented NAL unit -___ +*** ### f -• **f**: `number` +> **f**: `number` forbidden_zero_bit -___ +*** -### fragment +### fragment? -• `Optional` **fragment**: `Buffer` +> `optional` **fragment**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[fragment](DePacketizerBase.md#fragment) +[`DePacketizerBase`](DePacketizerBase.md).[`fragment`](DePacketizerBase.md#fragment) -___ +*** ### nalUnitPayloadType -• **nalUnitPayloadType**: `number` +> **nalUnitPayloadType**: `number` -___ +*** ### nalUnitType -• **nalUnitType**: `number` +> **nalUnitType**: `number` nal_unit_types -___ +*** ### nri -• **nri**: `number` +> **nri**: `number` nal_ref_idc -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** ### r -• **r**: `number` +> **r**: `number` -___ +*** ### s -• **s**: `number` +> **s**: `number` start of a fragmented NAL unit @@ -120,7 +96,7 @@ start of a fragmented NAL unit ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -128,13 +104,13 @@ start of a fragmented NAL unit #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` +> `get` **isPartitionHead**(): `boolean` #### Returns @@ -142,32 +118,29 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`, `fragment?`): [`H264RtpPayload`](H264RtpPayload.md) +> `static` **deSerialize**(`buf`, `fragment`?): [`H264RtpPayload`](H264RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `fragment?` | `Buffer` | +• **buf**: `Buffer` + +• **fragment?**: `Buffer` #### Returns [`H264RtpPayload`](H264RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/OpusRtpPayload.md b/packages/rtp/doc/classes/OpusRtpPayload.md index a73080d39..5f8b65dfd 100644 --- a/packages/rtp/doc/classes/OpusRtpPayload.md +++ b/packages/rtp/doc/classes/OpusRtpPayload.md @@ -1,4 +1,8 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / OpusRtpPayload +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / OpusRtpPayload # Class: OpusRtpPayload @@ -6,31 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](OpusRtpPayload.md#constructor) - -### Properties - -- [payload](OpusRtpPayload.md#payload) - -### Accessors - -- [isKeyframe](OpusRtpPayload.md#iskeyframe) - -### Methods - -- [createCodecPrivate](OpusRtpPayload.md#createcodecprivate) -- [deSerialize](OpusRtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](OpusRtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new OpusRtpPayload() -• **new OpusRtpPayload**(): [`OpusRtpPayload`](OpusRtpPayload.md) +> **new OpusRtpPayload**(): [`OpusRtpPayload`](OpusRtpPayload.md) #### Returns @@ -40,17 +24,17 @@ ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -58,51 +42,45 @@ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) ## Methods -### createCodecPrivate +### createCodecPrivate() -▸ **createCodecPrivate**(`samplingFrequency?`): `Buffer` +> `static` **createCodecPrivate**(`samplingFrequency`): `Buffer` #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `samplingFrequency` | `number` | `48000` | +• **samplingFrequency**: `number` = `48000` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`OpusRtpPayload`](OpusRtpPayload.md) +> `static` **deSerialize**(`buf`): [`OpusRtpPayload`](OpusRtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`OpusRtpPayload`](OpusRtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/PacketResult.md b/packages/rtp/doc/classes/PacketResult.md index 745e2fc78..0abd79f5e 100644 --- a/packages/rtp/doc/classes/PacketResult.md +++ b/packages/rtp/doc/classes/PacketResult.md @@ -1,31 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / PacketResult +[**werift-rtp**](../README.md) • **Docs** -# Class: PacketResult - -## Table of contents - -### Constructors +*** -- [constructor](PacketResult.md#constructor) +[werift-rtp](../globals.md) / PacketResult -### Properties - -- [delta](PacketResult.md#delta) -- [received](PacketResult.md#received) -- [receivedAtMs](PacketResult.md#receivedatms) -- [sequenceNumber](PacketResult.md#sequencenumber) +# Class: PacketResult ## Constructors -### constructor +### new PacketResult() -• **new PacketResult**(`props`): [`PacketResult`](PacketResult.md) +> **new PacketResult**(`props`): [`PacketResult`](PacketResult.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`PacketResult`](PacketResult.md)\> | +• **props**: `Partial`\<[`PacketResult`](PacketResult.md)\> #### Returns @@ -35,22 +24,22 @@ ### delta -• **delta**: `number` = `0` +> **delta**: `number` = `0` -___ +*** ### received -• **received**: `boolean` = `false` +> **received**: `boolean` = `false` -___ +*** ### receivedAtMs -• **receivedAtMs**: `number` = `0` +> **receivedAtMs**: `number` = `0` -___ +*** ### sequenceNumber -• **sequenceNumber**: `number` = `0` +> **sequenceNumber**: `number` = `0` diff --git a/packages/rtp/doc/classes/PictureLossIndication.md b/packages/rtp/doc/classes/PictureLossIndication.md index d2d9fed0b..26febd07f 100644 --- a/packages/rtp/doc/classes/PictureLossIndication.md +++ b/packages/rtp/doc/classes/PictureLossIndication.md @@ -1,37 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / PictureLossIndication +[**werift-rtp**](../README.md) • **Docs** -# Class: PictureLossIndication - -## Table of contents - -### Constructors - -- [constructor](PictureLossIndication.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / PictureLossIndication -- [count](PictureLossIndication.md#count) -- [length](PictureLossIndication.md#length) -- [mediaSsrc](PictureLossIndication.md#mediassrc) -- [senderSsrc](PictureLossIndication.md#senderssrc) -- [count](PictureLossIndication.md#count-1) - -### Methods - -- [serialize](PictureLossIndication.md#serialize) -- [deSerialize](PictureLossIndication.md#deserialize) +# Class: PictureLossIndication ## Constructors -### constructor +### new PictureLossIndication() -• **new PictureLossIndication**(`props?`): [`PictureLossIndication`](PictureLossIndication.md) +> **new PictureLossIndication**(`props`): [`PictureLossIndication`](PictureLossIndication.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`PictureLossIndication`](PictureLossIndication.md)\> | +• **props**: `Partial`\<[`PictureLossIndication`](PictureLossIndication.md)\> = `{}` #### Returns @@ -41,53 +24,51 @@ ### count -• **count**: `number` = `PictureLossIndication.count` +> **count**: `number` = `PictureLossIndication.count` -___ +*** ### length -• **length**: `number` = `2` +> **length**: `number` = `2` -___ +*** ### mediaSsrc -• **mediaSsrc**: `number` +> **mediaSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `1` +> `static` **count**: `number` = `1` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`PictureLossIndication`](PictureLossIndication.md) +> `static` **deSerialize**(`data`): [`PictureLossIndication`](PictureLossIndication.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/PromiseQueue.md b/packages/rtp/doc/classes/PromiseQueue.md index 378f95675..9f0c3ce2f 100644 --- a/packages/rtp/doc/classes/PromiseQueue.md +++ b/packages/rtp/doc/classes/PromiseQueue.md @@ -1,28 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / PromiseQueue +[**werift-rtp**](../README.md) • **Docs** -# Class: PromiseQueue - -## Table of contents - -### Constructors - -- [constructor](PromiseQueue.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / PromiseQueue -- [queue](PromiseQueue.md#queue) -- [running](PromiseQueue.md#running) - -### Methods - -- [cancel](PromiseQueue.md#cancel) -- [push](PromiseQueue.md#push) +# Class: PromiseQueue ## Constructors -### constructor +### new PromiseQueue() -• **new PromiseQueue**(): [`PromiseQueue`](PromiseQueue.md) +> **new PromiseQueue**(): [`PromiseQueue`](PromiseQueue.md) #### Returns @@ -32,41 +20,37 @@ ### queue -• **queue**: \{ `done`: (...`args`: `any`[]) => `void` ; `failed`: (...`args`: `any`[]) => `void` ; `promise`: () => `Promise`\<`unknown`\> }[] = `[]` +> **queue**: `object`[] = `[]` -___ +*** ### running -• **running**: `boolean` = `false` +> **running**: `boolean` = `false` ## Methods -### cancel +### cancel() -▸ **cancel**(): `void` +> **cancel**(): `void` #### Returns `void` -___ +*** -### push +### push() -▸ **push**\<`T`\>(`promise`): `Promise`\<`T`\> +> **push**\<`T`\>(`promise`): `Promise`\<`T`\> -#### Type parameters +#### Type Parameters -| Name | -| :------ | -| `T` | +• **T** #### Parameters -| Name | Type | -| :------ | :------ | -| `promise` | () => `Promise`\<`T`\> | +• **promise** #### Returns diff --git a/packages/rtp/doc/classes/ReceiverEstimatedMaxBitrate.md b/packages/rtp/doc/classes/ReceiverEstimatedMaxBitrate.md index 533ced444..adf2075b4 100644 --- a/packages/rtp/doc/classes/ReceiverEstimatedMaxBitrate.md +++ b/packages/rtp/doc/classes/ReceiverEstimatedMaxBitrate.md @@ -1,43 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / ReceiverEstimatedMaxBitrate +[**werift-rtp**](../README.md) • **Docs** -# Class: ReceiverEstimatedMaxBitrate - -## Table of contents - -### Constructors - -- [constructor](ReceiverEstimatedMaxBitrate.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / ReceiverEstimatedMaxBitrate -- [bitrate](ReceiverEstimatedMaxBitrate.md#bitrate) -- [brExp](ReceiverEstimatedMaxBitrate.md#brexp) -- [brMantissa](ReceiverEstimatedMaxBitrate.md#brmantissa) -- [count](ReceiverEstimatedMaxBitrate.md#count) -- [length](ReceiverEstimatedMaxBitrate.md#length) -- [mediaSsrc](ReceiverEstimatedMaxBitrate.md#mediassrc) -- [senderSsrc](ReceiverEstimatedMaxBitrate.md#senderssrc) -- [ssrcFeedbacks](ReceiverEstimatedMaxBitrate.md#ssrcfeedbacks) -- [ssrcNum](ReceiverEstimatedMaxBitrate.md#ssrcnum) -- [uniqueID](ReceiverEstimatedMaxBitrate.md#uniqueid) -- [count](ReceiverEstimatedMaxBitrate.md#count-1) - -### Methods - -- [serialize](ReceiverEstimatedMaxBitrate.md#serialize) -- [deSerialize](ReceiverEstimatedMaxBitrate.md#deserialize) +# Class: ReceiverEstimatedMaxBitrate ## Constructors -### constructor +### new ReceiverEstimatedMaxBitrate() -• **new ReceiverEstimatedMaxBitrate**(`props?`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) +> **new ReceiverEstimatedMaxBitrate**(`props`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md)\> | +• **props**: `Partial`\<[`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md)\> = `{}` #### Returns @@ -47,89 +24,87 @@ ### bitrate -• **bitrate**: `bigint` +> **bitrate**: `bigint` -___ +*** ### brExp -• **brExp**: `number` +> **brExp**: `number` -___ +*** ### brMantissa -• **brMantissa**: `number` +> **brMantissa**: `number` -___ +*** ### count -• **count**: `number` = `ReceiverEstimatedMaxBitrate.count` +> **count**: `number` = `ReceiverEstimatedMaxBitrate.count` -___ +*** ### length -• **length**: `number` +> **length**: `number` -___ +*** ### mediaSsrc -• **mediaSsrc**: `number` +> **mediaSsrc**: `number` -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### ssrcFeedbacks -• **ssrcFeedbacks**: `number`[] = `[]` +> **ssrcFeedbacks**: `number`[] = `[]` -___ +*** ### ssrcNum -• **ssrcNum**: `number` = `0` +> **ssrcNum**: `number` = `0` -___ +*** ### uniqueID -• `Readonly` **uniqueID**: `string` = `"REMB"` +> `readonly` **uniqueID**: `string` = `"REMB"` -___ +*** ### count -▪ `Static` **count**: `number` = `15` +> `static` **count**: `number` = `15` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) +> `static` **deSerialize**(`data`): [`ReceiverEstimatedMaxBitrate`](ReceiverEstimatedMaxBitrate.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RecvDelta.md b/packages/rtp/doc/classes/RecvDelta.md index d766d6415..61a73508d 100644 --- a/packages/rtp/doc/classes/RecvDelta.md +++ b/packages/rtp/doc/classes/RecvDelta.md @@ -1,37 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RecvDelta +[**werift-rtp**](../README.md) • **Docs** -# Class: RecvDelta - -## Table of contents - -### Constructors - -- [constructor](RecvDelta.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RecvDelta -- [delta](RecvDelta.md#delta) -- [parsed](RecvDelta.md#parsed) -- [type](RecvDelta.md#type) - -### Methods - -- [deSerialize](RecvDelta.md#deserialize) -- [parseDelta](RecvDelta.md#parsedelta) -- [serialize](RecvDelta.md#serialize) -- [deSerialize](RecvDelta.md#deserialize-1) +# Class: RecvDelta ## Constructors -### constructor +### new RecvDelta() -• **new RecvDelta**(`props?`): [`RecvDelta`](RecvDelta.md) +> **new RecvDelta**(`props`): [`RecvDelta`](RecvDelta.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RecvDelta`](RecvDelta.md)\> | +• **props**: `Partial`\<[`RecvDelta`](RecvDelta.md)\> = `{}` #### Returns @@ -41,71 +24,67 @@ ### delta -• **delta**: `number` +> **delta**: `number` micro sec -___ +*** ### parsed -• **parsed**: `boolean` = `false` +> **parsed**: `boolean` = `false` -___ +*** -### type +### type? -• `Optional` **type**: [`TypeTCCPacketReceivedSmallDelta`](../enums/PacketStatus.md#typetccpacketreceivedsmalldelta) \| [`TypeTCCPacketReceivedLargeDelta`](../enums/PacketStatus.md#typetccpacketreceivedlargedelta) +> `optional` **type**: [`TypeTCCPacketReceivedSmallDelta`](../enumerations/PacketStatus.md#typetccpacketreceivedsmalldelta) \| [`TypeTCCPacketReceivedLargeDelta`](../enumerations/PacketStatus.md#typetccpacketreceivedlargedelta) optional (If undefined, it will be set automatically.) ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): `void` +> **deSerialize**(`data`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns `void` -___ +*** -### parseDelta +### parseDelta() -▸ **parseDelta**(): `void` +> **parseDelta**(): `void` #### Returns `void` -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RecvDelta`](RecvDelta.md) +> `static` **deSerialize**(`data`): [`RecvDelta`](RecvDelta.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/Red.md b/packages/rtp/doc/classes/Red.md index 4c64d28b8..1ec333a71 100644 --- a/packages/rtp/doc/classes/Red.md +++ b/packages/rtp/doc/classes/Red.md @@ -1,28 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / Red +[**werift-rtp**](../README.md) • **Docs** -# Class: Red - -## Table of contents - -### Constructors - -- [constructor](Red.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / Red -- [blocks](Red.md#blocks) -- [header](Red.md#header) - -### Methods - -- [serialize](Red.md#serialize) -- [deSerialize](Red.md#deserialize) +# Class: Red ## Constructors -### constructor +### new Red() -• **new Red**(): [`Red`](Red.md) +> **new Red**(): [`Red`](Red.md) #### Returns @@ -32,35 +20,33 @@ ### blocks -• **blocks**: \{ `block`: `Buffer` ; `blockPT`: `number` ; `timestampOffset?`: `number` }[] = `[]` +> **blocks**: `object`[] = `[]` -___ +*** ### header -• **header**: [`RedHeader`](RedHeader.md) +> **header**: [`RedHeader`](RedHeader.md) ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`bufferOrArrayBuffer`): [`Red`](Red.md) +> `static` **deSerialize**(`bufferOrArrayBuffer`): [`Red`](Red.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `bufferOrArrayBuffer` | `Buffer` \| `ArrayBuffer` | +• **bufferOrArrayBuffer**: `Buffer` \| `ArrayBuffer` #### Returns diff --git a/packages/rtp/doc/classes/RedEncoder.md b/packages/rtp/doc/classes/RedEncoder.md index 5c8014bdd..e7dafad53 100644 --- a/packages/rtp/doc/classes/RedEncoder.md +++ b/packages/rtp/doc/classes/RedEncoder.md @@ -1,34 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RedEncoder +[**werift-rtp**](../README.md) • **Docs** -# Class: RedEncoder - -## Table of contents - -### Constructors - -- [constructor](RedEncoder.md#constructor) - -### Properties - -- [cacheSize](RedEncoder.md#cachesize) -- [distance](RedEncoder.md#distance) +*** -### Methods +[werift-rtp](../globals.md) / RedEncoder -- [build](RedEncoder.md#build) -- [push](RedEncoder.md#push) +# Class: RedEncoder ## Constructors -### constructor +### new RedEncoder() -• **new RedEncoder**(`distance?`): [`RedEncoder`](RedEncoder.md) +> **new RedEncoder**(`distance`): [`RedEncoder`](RedEncoder.md) #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `distance` | `number` | `1` | +• **distance**: `number` = `1` #### Returns @@ -38,38 +24,39 @@ ### cacheSize -• **cacheSize**: `number` = `10` +> **cacheSize**: `number` = `10` -___ +*** ### distance -• **distance**: `number` = `1` +> **distance**: `number` = `1` ## Methods -### build +### build() -▸ **build**(): [`Red`](Red.md) +> **build**(): [`Red`](Red.md) #### Returns [`Red`](Red.md) -___ +*** -### push +### push() -▸ **push**(`payload`): `void` +> **push**(`payload`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Object` | -| `payload.block` | `Buffer` | -| `payload.blockPT` | `number` | -| `payload.timestamp` | `number` | +• **payload** + +• **payload.block**: `Buffer` + +• **payload.blockPT**: `number` + +• **payload.timestamp**: `number` #### Returns diff --git a/packages/rtp/doc/classes/RedHandler.md b/packages/rtp/doc/classes/RedHandler.md index 8242d5982..2a9063ca0 100644 --- a/packages/rtp/doc/classes/RedHandler.md +++ b/packages/rtp/doc/classes/RedHandler.md @@ -1,22 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RedHandler +[**werift-rtp**](../README.md) • **Docs** -# Class: RedHandler - -## Table of contents - -### Constructors +*** -- [constructor](RedHandler.md#constructor) +[werift-rtp](../globals.md) / RedHandler -### Methods - -- [push](RedHandler.md#push) +# Class: RedHandler ## Constructors -### constructor +### new RedHandler() -• **new RedHandler**(): [`RedHandler`](RedHandler.md) +> **new RedHandler**(): [`RedHandler`](RedHandler.md) #### Returns @@ -24,16 +18,15 @@ ## Methods -### push +### push() -▸ **push**(`red`, `base`): [`RtpPacket`](RtpPacket.md)[] +> **push**(`red`, `base`): [`RtpPacket`](RtpPacket.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `red` | [`Red`](Red.md) | -| `base` | [`RtpPacket`](RtpPacket.md) | +• **red**: [`Red`](Red.md) + +• **base**: [`RtpPacket`](RtpPacket.md) #### Returns diff --git a/packages/rtp/doc/classes/RedHeader.md b/packages/rtp/doc/classes/RedHeader.md index 50af3b01d..7ebeda424 100644 --- a/packages/rtp/doc/classes/RedHeader.md +++ b/packages/rtp/doc/classes/RedHeader.md @@ -1,27 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RedHeader +[**werift-rtp**](../README.md) • **Docs** -# Class: RedHeader - -## Table of contents - -### Constructors - -- [constructor](RedHeader.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RedHeader -- [fields](RedHeader.md#fields) - -### Methods - -- [serialize](RedHeader.md#serialize) -- [deSerialize](RedHeader.md#deserialize) +# Class: RedHeader ## Constructors -### constructor +### new RedHeader() -• **new RedHeader**(): [`RedHeader`](RedHeader.md) +> **new RedHeader**(): [`RedHeader`](RedHeader.md) #### Returns @@ -31,29 +20,27 @@ ### fields -• **fields**: `RedHeaderField`[] = `[]` +> **fields**: `RedHeaderField`[] = `[]` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): readonly [[`RedHeader`](RedHeader.md), `number`] +> `static` **deSerialize**(`buf`): readonly [[`RedHeader`](RedHeader.md), `number`] #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtcpHeader.md b/packages/rtp/doc/classes/RtcpHeader.md index d67d1a173..620838ca7 100644 --- a/packages/rtp/doc/classes/RtcpHeader.md +++ b/packages/rtp/doc/classes/RtcpHeader.md @@ -1,37 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpHeader +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpHeader - -## Table of contents - -### Constructors - -- [constructor](RtcpHeader.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RtcpHeader -- [count](RtcpHeader.md#count) -- [length](RtcpHeader.md#length) -- [padding](RtcpHeader.md#padding) -- [type](RtcpHeader.md#type) -- [version](RtcpHeader.md#version) - -### Methods - -- [serialize](RtcpHeader.md#serialize) -- [deSerialize](RtcpHeader.md#deserialize) +# Class: RtcpHeader ## Constructors -### constructor +### new RtcpHeader() -• **new RtcpHeader**(`props?`): [`RtcpHeader`](RtcpHeader.md) +> **new RtcpHeader**(`props`): [`RtcpHeader`](RtcpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpHeader`](RtcpHeader.md)\> | +• **props**: `Partial`\<[`RtcpHeader`](RtcpHeader.md)\> = `{}` #### Returns @@ -41,55 +24,53 @@ ### count -• **count**: `number` = `0` +> **count**: `number` = `0` -___ +*** ### length -• **length**: `number` = `0` +> **length**: `number` = `0` このパケットの長さは、ヘッダーと任意のパディングを含む32ビットワードから 1を引いたものである -___ +*** ### padding -• **padding**: `boolean` = `false` +> **padding**: `boolean` = `false` -___ +*** ### type -• **type**: `number` = `0` +> **type**: `number` = `0` -___ +*** ### version -• **version**: `number` = `2` +> **version**: `number` = `2` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`RtcpHeader`](RtcpHeader.md) +> `static` **deSerialize**(`buf`): [`RtcpHeader`](RtcpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtcpPacketConverter.md b/packages/rtp/doc/classes/RtcpPacketConverter.md index 02bc85ce4..dc394e001 100644 --- a/packages/rtp/doc/classes/RtcpPacketConverter.md +++ b/packages/rtp/doc/classes/RtcpPacketConverter.md @@ -1,23 +1,16 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpPacketConverter +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpPacketConverter - -## Table of contents - -### Constructors - -- [constructor](RtcpPacketConverter.md#constructor) +*** -### Methods +[werift-rtp](../globals.md) / RtcpPacketConverter -- [deSerialize](RtcpPacketConverter.md#deserialize) -- [serialize](RtcpPacketConverter.md#serialize) +# Class: RtcpPacketConverter ## Constructors -### constructor +### new RtcpPacketConverter() -• **new RtcpPacketConverter**(): [`RtcpPacketConverter`](RtcpPacketConverter.md) +> **new RtcpPacketConverter**(): [`RtcpPacketConverter`](RtcpPacketConverter.md) #### Returns @@ -25,34 +18,33 @@ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpPacket`](../modules.md#rtcppacket)[] +> `static` **deSerialize**(`data`): [`RtcpPacket`](../type-aliases/RtcpPacket.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns -[`RtcpPacket`](../modules.md#rtcppacket)[] +[`RtcpPacket`](../type-aliases/RtcpPacket.md)[] -___ +*** -### serialize +### serialize() -▸ **serialize**(`type`, `count`, `payload`, `length`): `Buffer` +> `static` **serialize**(`type`, `count`, `payload`, `length`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `type` | `number` | -| `count` | `number` | -| `payload` | `Buffer` | -| `length` | `number` | +• **type**: `number` + +• **count**: `number` + +• **payload**: `Buffer` + +• **length**: `number` #### Returns diff --git a/packages/rtp/doc/classes/RtcpPayloadSpecificFeedback.md b/packages/rtp/doc/classes/RtcpPayloadSpecificFeedback.md index c81641f89..ffad441c8 100644 --- a/packages/rtp/doc/classes/RtcpPayloadSpecificFeedback.md +++ b/packages/rtp/doc/classes/RtcpPayloadSpecificFeedback.md @@ -1,35 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpPayloadSpecificFeedback +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpPayloadSpecificFeedback - -## Table of contents - -### Constructors - -- [constructor](RtcpPayloadSpecificFeedback.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RtcpPayloadSpecificFeedback -- [feedback](RtcpPayloadSpecificFeedback.md#feedback) -- [type](RtcpPayloadSpecificFeedback.md#type) -- [type](RtcpPayloadSpecificFeedback.md#type-1) - -### Methods - -- [serialize](RtcpPayloadSpecificFeedback.md#serialize) -- [deSerialize](RtcpPayloadSpecificFeedback.md#deserialize) +# Class: RtcpPayloadSpecificFeedback ## Constructors -### constructor +### new RtcpPayloadSpecificFeedback() -• **new RtcpPayloadSpecificFeedback**(`props?`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) +> **new RtcpPayloadSpecificFeedback**(`props`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md)\> | +• **props**: `Partial`\<[`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md)\> = `{}` #### Returns @@ -39,42 +24,41 @@ ### feedback -• **feedback**: `Feedback` +> **feedback**: `Feedback` -___ +*** ### type -• `Readonly` **type**: ``206`` +> `readonly` **type**: `206` = `RtcpPayloadSpecificFeedback.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``206`` +> `readonly` `static` **type**: `206` = `206` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) +> `static` **deSerialize**(`data`, `header`): [`RtcpPayloadSpecificFeedback`](RtcpPayloadSpecificFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/RtcpReceiverInfo.md b/packages/rtp/doc/classes/RtcpReceiverInfo.md index fa8b2e874..f2482d8ee 100644 --- a/packages/rtp/doc/classes/RtcpReceiverInfo.md +++ b/packages/rtp/doc/classes/RtcpReceiverInfo.md @@ -1,40 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpReceiverInfo +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpReceiverInfo - -## Table of contents - -### Constructors - -- [constructor](RtcpReceiverInfo.md#constructor) - -### Properties +*** -- [dlsr](RtcpReceiverInfo.md#dlsr) -- [fractionLost](RtcpReceiverInfo.md#fractionlost) -- [highestSequence](RtcpReceiverInfo.md#highestsequence) -- [jitter](RtcpReceiverInfo.md#jitter) -- [lsr](RtcpReceiverInfo.md#lsr) -- [packetsLost](RtcpReceiverInfo.md#packetslost) -- [ssrc](RtcpReceiverInfo.md#ssrc) +[werift-rtp](../globals.md) / RtcpReceiverInfo -### Methods - -- [serialize](RtcpReceiverInfo.md#serialize) -- [toJSON](RtcpReceiverInfo.md#tojson) -- [deSerialize](RtcpReceiverInfo.md#deserialize) +# Class: RtcpReceiverInfo ## Constructors -### constructor +### new RtcpReceiverInfo() -• **new RtcpReceiverInfo**(`props?`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) +> **new RtcpReceiverInfo**(`props`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpReceiverInfo`](RtcpReceiverInfo.md)\> | +• **props**: `Partial`\<[`RtcpReceiverInfo`](RtcpReceiverInfo.md)\> = `{}` #### Returns @@ -44,89 +24,105 @@ ### dlsr -• **dlsr**: `number` +> **dlsr**: `number` delay since last SR -___ +*** ### fractionLost -• **fractionLost**: `number` +> **fractionLost**: `number` -___ +*** ### highestSequence -• **highestSequence**: `number` +> **highestSequence**: `number` -___ +*** ### jitter -• **jitter**: `number` +> **jitter**: `number` -___ +*** ### lsr -• **lsr**: `number` +> **lsr**: `number` last SR -___ +*** ### packetsLost -• **packetsLost**: `number` +> **packetsLost**: `number` -___ +*** ### ssrc -• **ssrc**: `number` +> **ssrc**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### dlsr + +> **dlsr**: `number` + +##### fractionLost + +> **fractionLost**: `number` + +##### highestSequence + +> **highestSequence**: `number` + +##### jitter + +> **jitter**: `number` + +##### lsr + +> **lsr**: `number` + +##### packetsLost + +> **packetsLost**: `number` + +##### ssrc -| Name | Type | -| :------ | :------ | -| `dlsr` | `number` | -| `fractionLost` | `number` | -| `highestSequence` | `number` | -| `jitter` | `number` | -| `lsr` | `number` | -| `packetsLost` | `number` | -| `ssrc` | `number` | +> **ssrc**: `number` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) +> `static` **deSerialize**(`data`): [`RtcpReceiverInfo`](RtcpReceiverInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtcpRrPacket.md b/packages/rtp/doc/classes/RtcpRrPacket.md index 93e63f891..79feb0f4c 100644 --- a/packages/rtp/doc/classes/RtcpRrPacket.md +++ b/packages/rtp/doc/classes/RtcpRrPacket.md @@ -1,36 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpRrPacket +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpRrPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpRrPacket.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RtcpRrPacket -- [reports](RtcpRrPacket.md#reports) -- [ssrc](RtcpRrPacket.md#ssrc) -- [type](RtcpRrPacket.md#type) -- [type](RtcpRrPacket.md#type-1) - -### Methods - -- [serialize](RtcpRrPacket.md#serialize) -- [deSerialize](RtcpRrPacket.md#deserialize) +# Class: RtcpRrPacket ## Constructors -### constructor +### new RtcpRrPacket() -• **new RtcpRrPacket**(`props?`): [`RtcpRrPacket`](RtcpRrPacket.md) +> **new RtcpRrPacket**(`props`): [`RtcpRrPacket`](RtcpRrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpRrPacket`](RtcpRrPacket.md)\> | +• **props**: `Partial`\<[`RtcpRrPacket`](RtcpRrPacket.md)\> = `{}` #### Returns @@ -40,48 +24,47 @@ ### reports -• **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` +> **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### type -• `Readonly` **type**: ``201`` +> `readonly` **type**: `201` = `RtcpRrPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``201`` +> `readonly` `static` **type**: `201` = `201` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `count`): [`RtcpRrPacket`](RtcpRrPacket.md) +> `static` **deSerialize**(`data`, `count`): [`RtcpRrPacket`](RtcpRrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `count` | `number` | +• **data**: `Buffer` + +• **count**: `number` #### Returns diff --git a/packages/rtp/doc/classes/RtcpSenderInfo.md b/packages/rtp/doc/classes/RtcpSenderInfo.md index 744369b5a..a34121d61 100644 --- a/packages/rtp/doc/classes/RtcpSenderInfo.md +++ b/packages/rtp/doc/classes/RtcpSenderInfo.md @@ -1,37 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpSenderInfo +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpSenderInfo - -## Table of contents - -### Constructors - -- [constructor](RtcpSenderInfo.md#constructor) - -### Properties +*** -- [ntpTimestamp](RtcpSenderInfo.md#ntptimestamp) -- [octetCount](RtcpSenderInfo.md#octetcount) -- [packetCount](RtcpSenderInfo.md#packetcount) -- [rtpTimestamp](RtcpSenderInfo.md#rtptimestamp) +[werift-rtp](../globals.md) / RtcpSenderInfo -### Methods - -- [serialize](RtcpSenderInfo.md#serialize) -- [toJSON](RtcpSenderInfo.md#tojson) -- [deSerialize](RtcpSenderInfo.md#deserialize) +# Class: RtcpSenderInfo ## Constructors -### constructor +### new RtcpSenderInfo() -• **new RtcpSenderInfo**(`props?`): [`RtcpSenderInfo`](RtcpSenderInfo.md) +> **new RtcpSenderInfo**(`props`): [`RtcpSenderInfo`](RtcpSenderInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpSenderInfo`](RtcpSenderInfo.md)\> | +• **props**: `Partial`\<[`RtcpSenderInfo`](RtcpSenderInfo.md)\> = `{}` #### Returns @@ -41,62 +24,63 @@ ### ntpTimestamp -• **ntpTimestamp**: `bigint` +> **ntpTimestamp**: `bigint` -___ +*** ### octetCount -• **octetCount**: `number` +> **octetCount**: `number` -___ +*** ### packetCount -• **packetCount**: `number` +> **packetCount**: `number` -___ +*** ### rtpTimestamp -• **rtpTimestamp**: `number` +> **rtpTimestamp**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### ntpTimestamp + +> **ntpTimestamp**: `number` + +##### rtpTimestamp -| Name | Type | -| :------ | :------ | -| `ntpTimestamp` | `number` | -| `rtpTimestamp` | `number` | +> **rtpTimestamp**: `number` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RtcpSenderInfo`](RtcpSenderInfo.md) +> `static` **deSerialize**(`data`): [`RtcpSenderInfo`](RtcpSenderInfo.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtcpSourceDescriptionPacket.md b/packages/rtp/doc/classes/RtcpSourceDescriptionPacket.md index 3d392f698..2e96f2b8e 100644 --- a/packages/rtp/doc/classes/RtcpSourceDescriptionPacket.md +++ b/packages/rtp/doc/classes/RtcpSourceDescriptionPacket.md @@ -1,39 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpSourceDescriptionPacket +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpSourceDescriptionPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpSourceDescriptionPacket.md#constructor) - -### Properties +*** -- [chunks](RtcpSourceDescriptionPacket.md#chunks) -- [type](RtcpSourceDescriptionPacket.md#type) -- [type](RtcpSourceDescriptionPacket.md#type-1) +[werift-rtp](../globals.md) / RtcpSourceDescriptionPacket -### Accessors - -- [length](RtcpSourceDescriptionPacket.md#length) - -### Methods - -- [serialize](RtcpSourceDescriptionPacket.md#serialize) -- [deSerialize](RtcpSourceDescriptionPacket.md#deserialize) +# Class: RtcpSourceDescriptionPacket ## Constructors -### constructor +### new RtcpSourceDescriptionPacket() -• **new RtcpSourceDescriptionPacket**(`props`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) +> **new RtcpSourceDescriptionPacket**(`props`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md)\> | +• **props**: `Partial`\<[`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md)\> #### Returns @@ -43,25 +24,25 @@ ### chunks -• **chunks**: [`SourceDescriptionChunk`](SourceDescriptionChunk.md)[] = `[]` +> **chunks**: [`SourceDescriptionChunk`](SourceDescriptionChunk.md)[] = `[]` -___ +*** ### type -• `Readonly` **type**: ``202`` +> `readonly` **type**: `202` = `RtcpSourceDescriptionPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``202`` +> `readonly` `static` **type**: `202` = `202` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -69,26 +50,25 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`payload`, `header`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) +> `static` **deSerialize**(`payload`, `header`): [`RtcpSourceDescriptionPacket`](RtcpSourceDescriptionPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **payload**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/RtcpSrPacket.md b/packages/rtp/doc/classes/RtcpSrPacket.md index 27db48fde..38f7e0713 100644 --- a/packages/rtp/doc/classes/RtcpSrPacket.md +++ b/packages/rtp/doc/classes/RtcpSrPacket.md @@ -1,38 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpSrPacket +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpSrPacket - -## Table of contents - -### Constructors - -- [constructor](RtcpSrPacket.md#constructor) - -### Properties +*** -- [reports](RtcpSrPacket.md#reports) -- [senderInfo](RtcpSrPacket.md#senderinfo) -- [ssrc](RtcpSrPacket.md#ssrc) -- [type](RtcpSrPacket.md#type) -- [type](RtcpSrPacket.md#type-1) +[werift-rtp](../globals.md) / RtcpSrPacket -### Methods - -- [serialize](RtcpSrPacket.md#serialize) -- [toJSON](RtcpSrPacket.md#tojson) -- [deSerialize](RtcpSrPacket.md#deserialize) +# Class: RtcpSrPacket ## Constructors -### constructor +### new RtcpSrPacket() -• **new RtcpSrPacket**(`props`): [`RtcpSrPacket`](RtcpSrPacket.md) +> **new RtcpSrPacket**(`props`): [`RtcpSrPacket`](RtcpSrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Pick`\<[`RtcpSrPacket`](RtcpSrPacket.md), ``"senderInfo"``\> & `Partial`\<[`RtcpSrPacket`](RtcpSrPacket.md)\> | +• **props**: `Pick`\<[`RtcpSrPacket`](RtcpSrPacket.md), `"senderInfo"`\> & `Partial`\<[`RtcpSrPacket`](RtcpSrPacket.md)\> #### Returns @@ -42,72 +24,83 @@ ### reports -• **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` +> **reports**: [`RtcpReceiverInfo`](RtcpReceiverInfo.md)[] = `[]` -___ +*** ### senderInfo -• **senderInfo**: [`RtcpSenderInfo`](RtcpSenderInfo.md) +> **senderInfo**: [`RtcpSenderInfo`](RtcpSenderInfo.md) -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### type -• `Readonly` **type**: ``200`` +> `readonly` **type**: `200` = `RtcpSrPacket.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``200`` +> `readonly` `static` **type**: `200` = `200` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` + +##### reports + +> **reports**: `object`[] -| Name | Type | -| :------ | :------ | -| `reports` | \{ `dlsr`: `number` ; `fractionLost`: `number` ; `highestSequence`: `number` ; `jitter`: `number` ; `lsr`: `number` ; `packetsLost`: `number` ; `ssrc`: `number` }[] | -| `senderInfo` | \{ `ntpTimestamp`: `number` ; `rtpTimestamp`: `number` } | -| `senderInfo.ntpTimestamp` | `number` | -| `senderInfo.rtpTimestamp` | `number` | -| `ssrc` | `number` | +##### senderInfo -___ +> **senderInfo**: `object` -### deSerialize +##### senderInfo.ntpTimestamp -▸ **deSerialize**(`payload`, `count`): [`RtcpSrPacket`](RtcpSrPacket.md) +> **ntpTimestamp**: `number` + +##### senderInfo.rtpTimestamp + +> **rtpTimestamp**: `number` + +##### ssrc + +> **ssrc**: `number` + +*** + +### deSerialize() + +> `static` **deSerialize**(`payload`, `count`): [`RtcpSrPacket`](RtcpSrPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `count` | `number` | +• **payload**: `Buffer` + +• **count**: `number` #### Returns diff --git a/packages/rtp/doc/classes/RtcpTransportLayerFeedback.md b/packages/rtp/doc/classes/RtcpTransportLayerFeedback.md index 7b25d5e13..f2a1e03cc 100644 --- a/packages/rtp/doc/classes/RtcpTransportLayerFeedback.md +++ b/packages/rtp/doc/classes/RtcpTransportLayerFeedback.md @@ -1,36 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtcpTransportLayerFeedback +[**werift-rtp**](../README.md) • **Docs** -# Class: RtcpTransportLayerFeedback - -## Table of contents - -### Constructors - -- [constructor](RtcpTransportLayerFeedback.md#constructor) - -### Properties +*** -- [feedback](RtcpTransportLayerFeedback.md#feedback) -- [header](RtcpTransportLayerFeedback.md#header) -- [type](RtcpTransportLayerFeedback.md#type) -- [type](RtcpTransportLayerFeedback.md#type-1) +[werift-rtp](../globals.md) / RtcpTransportLayerFeedback -### Methods - -- [serialize](RtcpTransportLayerFeedback.md#serialize) -- [deSerialize](RtcpTransportLayerFeedback.md#deserialize) +# Class: RtcpTransportLayerFeedback ## Constructors -### constructor +### new RtcpTransportLayerFeedback() -• **new RtcpTransportLayerFeedback**(`props?`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) +> **new RtcpTransportLayerFeedback**(`props`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md)\> | +• **props**: `Partial`\<[`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md)\> = `{}` #### Returns @@ -40,48 +24,47 @@ ### feedback -• **feedback**: `Feedback` +> **feedback**: `Feedback` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### type -• `Readonly` **type**: ``205`` +> `readonly` **type**: `205` = `RtcpTransportLayerFeedback.type` -___ +*** ### type -▪ `Static` `Readonly` **type**: ``205`` +> `readonly` `static` **type**: `205` = `205` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) +> `static` **deSerialize**(`data`, `header`): [`RtcpTransportLayerFeedback`](RtcpTransportLayerFeedback.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/RtpBuilder.md b/packages/rtp/doc/classes/RtpBuilder.md index 8f8963436..32abba07a 100644 --- a/packages/rtp/doc/classes/RtpBuilder.md +++ b/packages/rtp/doc/classes/RtpBuilder.md @@ -1,35 +1,24 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtpBuilder +[**werift-rtp**](../README.md) • **Docs** -# Class: RtpBuilder - -## Table of contents - -### Constructors - -- [constructor](RtpBuilder.md#constructor) - -### Properties +*** -- [sequenceNumber](RtpBuilder.md#sequencenumber) -- [timestamp](RtpBuilder.md#timestamp) +[werift-rtp](../globals.md) / RtpBuilder -### Methods - -- [create](RtpBuilder.md#create) +# Class: RtpBuilder ## Constructors -### constructor +### new RtpBuilder() -• **new RtpBuilder**(`props`): [`RtpBuilder`](RtpBuilder.md) +> **new RtpBuilder**(`props`): [`RtpBuilder`](RtpBuilder.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.between` | `number` | -| `props.clockRate` | `number` | +• **props** + +• **props.between**: `number` + +• **props.clockRate**: `number` #### Returns @@ -39,25 +28,23 @@ ### sequenceNumber -• **sequenceNumber**: `any` +> **sequenceNumber**: `number` -___ +*** ### timestamp -• **timestamp**: `any` +> **timestamp**: `number` ## Methods -### create +### create() -▸ **create**(`payload`): [`RtpPacket`](RtpPacket.md) +> **create**(`payload`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | +• **payload**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtpHeader.md b/packages/rtp/doc/classes/RtpHeader.md index 957326b5c..1d7b1211e 100644 --- a/packages/rtp/doc/classes/RtpHeader.md +++ b/packages/rtp/doc/classes/RtpHeader.md @@ -1,51 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtpHeader +[**werift-rtp**](../README.md) • **Docs** -# Class: RtpHeader - -## Table of contents - -### Constructors - -- [constructor](RtpHeader.md#constructor) - -### Properties +*** -- [csrc](RtpHeader.md#csrc) -- [csrcLength](RtpHeader.md#csrclength) -- [extension](RtpHeader.md#extension) -- [extensionLength](RtpHeader.md#extensionlength) -- [extensionProfile](RtpHeader.md#extensionprofile) -- [extensions](RtpHeader.md#extensions) -- [marker](RtpHeader.md#marker) -- [padding](RtpHeader.md#padding) -- [paddingSize](RtpHeader.md#paddingsize) -- [payloadOffset](RtpHeader.md#payloadoffset) -- [payloadType](RtpHeader.md#payloadtype) -- [sequenceNumber](RtpHeader.md#sequencenumber) -- [ssrc](RtpHeader.md#ssrc) -- [timestamp](RtpHeader.md#timestamp) -- [version](RtpHeader.md#version) +[werift-rtp](../globals.md) / RtpHeader -### Accessors - -- [serializeSize](RtpHeader.md#serializesize) - -### Methods - -- [serialize](RtpHeader.md#serialize) -- [deSerialize](RtpHeader.md#deserialize) +# Class: RtpHeader ## Constructors -### constructor +### new RtpHeader() -• **new RtpHeader**(`props?`): [`RtpHeader`](RtpHeader.md) +> **new RtpHeader**(`props`): [`RtpHeader`](RtpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RtpHeader`](RtpHeader.md)\> | +• **props**: `Partial`\<[`RtpHeader`](RtpHeader.md)\> = `{}` #### Returns @@ -55,103 +24,103 @@ ### csrc -• **csrc**: `number`[] = `[]` +> **csrc**: `number`[] = `[]` -___ +*** ### csrcLength -• **csrcLength**: `number` = `0` +> **csrcLength**: `number` = `0` -___ +*** ### extension -• **extension**: `boolean` = `false` +> **extension**: `boolean` = `false` -___ +*** -### extensionLength +### extensionLength? -• `Optional` **extensionLength**: `number` +> `optional` **extensionLength**: `number` deserialize only -___ +*** ### extensionProfile -• **extensionProfile**: `ExtensionProfile` = `ExtensionProfiles.OneByte` +> **extensionProfile**: `ExtensionProfile` = `ExtensionProfiles.OneByte` -___ +*** ### extensions -• **extensions**: [`Extension`](../modules.md#extension)[] = `[]` +> **extensions**: [`Extension`](../type-aliases/Extension.md)[] = `[]` -___ +*** ### marker -• **marker**: `boolean` = `false` +> **marker**: `boolean` = `false` -___ +*** ### padding -• **padding**: `boolean` = `false` +> **padding**: `boolean` = `false` -___ +*** ### paddingSize -• **paddingSize**: `number` = `0` +> **paddingSize**: `number` = `0` -___ +*** ### payloadOffset -• **payloadOffset**: `number` = `0` +> **payloadOffset**: `number` = `0` -___ +*** ### payloadType -• **payloadType**: `number` = `0` +> **payloadType**: `number` = `0` -___ +*** ### sequenceNumber -• **sequenceNumber**: `number` = `0` +> **sequenceNumber**: `number` = `0` 16bit, 初期値はランダムである必要があります -___ +*** ### ssrc -• **ssrc**: `number` = `0` +> **ssrc**: `number` = `0` -___ +*** ### timestamp -• **timestamp**: `number` = `0` +> **timestamp**: `number` = `0` 32bit microsec (milli/1000), 初期値はランダムである必要があります -___ +*** ### version -• **version**: `number` = `2` +> **version**: `number` = `2` ## Accessors ### serializeSize -• `get` **serializeSize**(): `number` +> `get` **serializeSize**(): `number` #### Returns @@ -159,31 +128,27 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(`size`): `Buffer` +> **serialize**(`size`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `size` | `number` | +• **size**: `number` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`rawPacket`): [`RtpHeader`](RtpHeader.md) +> `static` **deSerialize**(`rawPacket`): [`RtpHeader`](RtpHeader.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `rawPacket` | `Buffer` | +• **rawPacket**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RtpPacket.md b/packages/rtp/doc/classes/RtpPacket.md index d63478061..45850f3c4 100644 --- a/packages/rtp/doc/classes/RtpPacket.md +++ b/packages/rtp/doc/classes/RtpPacket.md @@ -1,41 +1,22 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RtpPacket +[**werift-rtp**](../README.md) • **Docs** -# Class: RtpPacket - -## Table of contents - -### Constructors - -- [constructor](RtpPacket.md#constructor) - -### Properties - -- [header](RtpPacket.md#header) -- [payload](RtpPacket.md#payload) - -### Accessors +*** -- [serializeSize](RtpPacket.md#serializesize) +[werift-rtp](../globals.md) / RtpPacket -### Methods - -- [clear](RtpPacket.md#clear) -- [clone](RtpPacket.md#clone) -- [serialize](RtpPacket.md#serialize) -- [deSerialize](RtpPacket.md#deserialize) +# Class: RtpPacket ## Constructors -### constructor +### new RtpPacket() -• **new RtpPacket**(`header`, `payload`): [`RtpPacket`](RtpPacket.md) +> **new RtpPacket**(`header`, `payload`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | -| `payload` | `Buffer` | +• **header**: [`RtpHeader`](RtpHeader.md) + +• **payload**: `Buffer` #### Returns @@ -45,19 +26,19 @@ ### header -• **header**: [`RtpHeader`](RtpHeader.md) +> **header**: [`RtpHeader`](RtpHeader.md) -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` ## Accessors ### serializeSize -• `get` **serializeSize**(): `number` +> `get` **serializeSize**(): `number` #### Returns @@ -65,45 +46,43 @@ ___ ## Methods -### clear +### clear() -▸ **clear**(): `void` +> **clear**(): `void` #### Returns `void` -___ +*** -### clone +### clone() -▸ **clone**(): [`RtpPacket`](RtpPacket.md) +> **clone**(): [`RtpPacket`](RtpPacket.md) #### Returns [`RtpPacket`](RtpPacket.md) -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`RtpPacket`](RtpPacket.md) +> `static` **deSerialize**(`buf`): [`RtpPacket`](RtpPacket.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/RunLengthChunk.md b/packages/rtp/doc/classes/RunLengthChunk.md index 913c68804..cb5236ead 100644 --- a/packages/rtp/doc/classes/RunLengthChunk.md +++ b/packages/rtp/doc/classes/RunLengthChunk.md @@ -1,36 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / RunLengthChunk +[**werift-rtp**](../README.md) • **Docs** -# Class: RunLengthChunk - -## Table of contents - -### Constructors - -- [constructor](RunLengthChunk.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / RunLengthChunk -- [packetStatus](RunLengthChunk.md#packetstatus) -- [runLength](RunLengthChunk.md#runlength) -- [type](RunLengthChunk.md#type) - -### Methods - -- [results](RunLengthChunk.md#results) -- [serialize](RunLengthChunk.md#serialize) -- [deSerialize](RunLengthChunk.md#deserialize) +# Class: RunLengthChunk ## Constructors -### constructor +### new RunLengthChunk() -• **new RunLengthChunk**(`props?`): [`RunLengthChunk`](RunLengthChunk.md) +> **new RunLengthChunk**(`props`): [`RunLengthChunk`](RunLengthChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`RunLengthChunk`](RunLengthChunk.md)\> | +• **props**: `Partial`\<[`RunLengthChunk`](RunLengthChunk.md)\> = `{}` #### Returns @@ -40,59 +24,55 @@ ### packetStatus -• **packetStatus**: [`PacketStatus`](../enums/PacketStatus.md) +> **packetStatus**: [`PacketStatus`](../enumerations/PacketStatus.md) -___ +*** ### runLength -• **runLength**: `number` +> **runLength**: `number` 13bit -___ +*** ### type -• **type**: [`TypeTCCRunLengthChunk`](../enums/PacketChunk.md#typetccrunlengthchunk) +> **type**: [`TypeTCCRunLengthChunk`](../enumerations/PacketChunk.md#typetccrunlengthchunk) ## Methods -### results +### results() -▸ **results**(`currentSequenceNumber`): [`PacketResult`](PacketResult.md)[] +> **results**(`currentSequenceNumber`): [`PacketResult`](PacketResult.md)[] #### Parameters -| Name | Type | -| :------ | :------ | -| `currentSequenceNumber` | `number` | +• **currentSequenceNumber**: `number` #### Returns [`PacketResult`](PacketResult.md)[] -___ +*** -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`RunLengthChunk`](RunLengthChunk.md) +> `static` **deSerialize**(`data`): [`RunLengthChunk`](RunLengthChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/SourceDescriptionChunk.md b/packages/rtp/doc/classes/SourceDescriptionChunk.md index b6e8be618..e96bca89f 100644 --- a/packages/rtp/doc/classes/SourceDescriptionChunk.md +++ b/packages/rtp/doc/classes/SourceDescriptionChunk.md @@ -1,38 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / SourceDescriptionChunk +[**werift-rtp**](../README.md) • **Docs** -# Class: SourceDescriptionChunk - -## Table of contents - -### Constructors - -- [constructor](SourceDescriptionChunk.md#constructor) - -### Properties +*** -- [items](SourceDescriptionChunk.md#items) -- [source](SourceDescriptionChunk.md#source) +[werift-rtp](../globals.md) / SourceDescriptionChunk -### Accessors - -- [length](SourceDescriptionChunk.md#length) - -### Methods - -- [serialize](SourceDescriptionChunk.md#serialize) -- [deSerialize](SourceDescriptionChunk.md#deserialize) +# Class: SourceDescriptionChunk ## Constructors -### constructor +### new SourceDescriptionChunk() -• **new SourceDescriptionChunk**(`props?`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) +> **new SourceDescriptionChunk**(`props`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`SourceDescriptionChunk`](SourceDescriptionChunk.md)\> | +• **props**: `Partial`\<[`SourceDescriptionChunk`](SourceDescriptionChunk.md)\> = `{}` #### Returns @@ -42,19 +24,19 @@ ### items -• **items**: [`SourceDescriptionItem`](SourceDescriptionItem.md)[] = `[]` +> **items**: [`SourceDescriptionItem`](SourceDescriptionItem.md)[] = `[]` -___ +*** ### source -• **source**: `number` +> **source**: `number` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -62,25 +44,23 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) +> `static` **deSerialize**(`data`): [`SourceDescriptionChunk`](SourceDescriptionChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/SourceDescriptionItem.md b/packages/rtp/doc/classes/SourceDescriptionItem.md index 070320421..a063bd0e6 100644 --- a/packages/rtp/doc/classes/SourceDescriptionItem.md +++ b/packages/rtp/doc/classes/SourceDescriptionItem.md @@ -1,38 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / SourceDescriptionItem +[**werift-rtp**](../README.md) • **Docs** -# Class: SourceDescriptionItem - -## Table of contents - -### Constructors - -- [constructor](SourceDescriptionItem.md#constructor) - -### Properties +*** -- [text](SourceDescriptionItem.md#text) -- [type](SourceDescriptionItem.md#type) +[werift-rtp](../globals.md) / SourceDescriptionItem -### Accessors - -- [length](SourceDescriptionItem.md#length) - -### Methods - -- [serialize](SourceDescriptionItem.md#serialize) -- [deSerialize](SourceDescriptionItem.md#deserialize) +# Class: SourceDescriptionItem ## Constructors -### constructor +### new SourceDescriptionItem() -• **new SourceDescriptionItem**(`props`): [`SourceDescriptionItem`](SourceDescriptionItem.md) +> **new SourceDescriptionItem**(`props`): [`SourceDescriptionItem`](SourceDescriptionItem.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`SourceDescriptionItem`](SourceDescriptionItem.md)\> | +• **props**: `Partial`\<[`SourceDescriptionItem`](SourceDescriptionItem.md)\> #### Returns @@ -42,19 +24,19 @@ ### text -• **text**: `string` +> **text**: `string` -___ +*** ### type -• **type**: `number` +> **type**: `number` ## Accessors ### length -• `get` **length**(): `number` +> `get` **length**(): `number` #### Returns @@ -62,25 +44,23 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`SourceDescriptionItem`](SourceDescriptionItem.md) +> `static` **deSerialize**(`data`): [`SourceDescriptionItem`](SourceDescriptionItem.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/SrtcpSession.md b/packages/rtp/doc/classes/SrtcpSession.md index 7a8eb238c..f387010be 100644 --- a/packages/rtp/doc/classes/SrtcpSession.md +++ b/packages/rtp/doc/classes/SrtcpSession.md @@ -1,43 +1,24 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / SrtcpSession +[**werift-rtp**](../README.md) • **Docs** -# Class: SrtcpSession - -## Hierarchy - -- `Session`\<`SrtcpContext`\> - - ↳ **`SrtcpSession`** +*** -## Table of contents +[werift-rtp](../globals.md) / SrtcpSession -### Constructors - -- [constructor](SrtcpSession.md#constructor) - -### Properties - -- [config](SrtcpSession.md#config) -- [localContext](SrtcpSession.md#localcontext) -- [onData](SrtcpSession.md#ondata) -- [remoteContext](SrtcpSession.md#remotecontext) +# Class: SrtcpSession -### Methods +## Extends -- [decrypt](SrtcpSession.md#decrypt) -- [encrypt](SrtcpSession.md#encrypt) -- [start](SrtcpSession.md#start) +- `Session`\<`SrtcpContext`\> ## Constructors -### constructor +### new SrtcpSession() -• **new SrtcpSession**(`config`): [`SrtcpSession`](SrtcpSession.md) +> **new SrtcpSession**(`config`): [`SrtcpSession`](SrtcpSession.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | `Config` | +• **config**: `Config` #### Returns @@ -45,105 +26,97 @@ #### Overrides -Session\<SrtcpContext\>.constructor +`Session.constructor` ## Properties ### config -• **config**: `Config` +> **config**: `Config` -___ +*** ### localContext -• **localContext**: `SrtcpContext` +> **localContext**: `SrtcpContext` #### Inherited from -Session.localContext - -___ +`Session.localContext` -### onData +*** -• `Optional` **onData**: (`buf`: `Buffer`) => `void` +### onData()? -#### Type declaration +> `optional` **onData**: (`buf`) => `void` -▸ (`buf`): `void` - -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` -##### Returns +#### Returns `void` #### Inherited from -Session.onData +`Session.onData` -___ +*** ### remoteContext -• **remoteContext**: `SrtcpContext` +> **remoteContext**: `SrtcpContext` #### Inherited from -Session.remoteContext +`Session.remoteContext` ## Methods -### decrypt +### decrypt() -▸ **decrypt**(`buf`): `Buffer` +> **decrypt**(`buf`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns `Buffer` -___ +*** -### encrypt +### encrypt() -▸ **encrypt**(`rawRtcp`): `Buffer` +> **encrypt**(`rawRtcp`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `rawRtcp` | `Buffer` | +• **rawRtcp**: `Buffer` #### Returns `Buffer` -___ +*** -### start +### start() -▸ **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` +> **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `localMasterKey` | `Buffer` | -| `localMasterSalt` | `Buffer` | -| `remoteMasterKey` | `Buffer` | -| `remoteMasterSalt` | `Buffer` | -| `profile` | `number` | +• **localMasterKey**: `Buffer` + +• **localMasterSalt**: `Buffer` + +• **remoteMasterKey**: `Buffer` + +• **remoteMasterSalt**: `Buffer` + +• **profile**: `number` #### Returns @@ -151,4 +124,4 @@ ___ #### Inherited from -Session.start +`Session.start` diff --git a/packages/rtp/doc/classes/SrtpSession.md b/packages/rtp/doc/classes/SrtpSession.md index 7d5a77c6a..bad979715 100644 --- a/packages/rtp/doc/classes/SrtpSession.md +++ b/packages/rtp/doc/classes/SrtpSession.md @@ -1,43 +1,24 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / SrtpSession +[**werift-rtp**](../README.md) • **Docs** -# Class: SrtpSession - -## Hierarchy - -- `Session`\<`SrtpContext`\> - - ↳ **`SrtpSession`** - -## Table of contents +*** -### Constructors +[werift-rtp](../globals.md) / SrtpSession -- [constructor](SrtpSession.md#constructor) - -### Properties - -- [config](SrtpSession.md#config) -- [localContext](SrtpSession.md#localcontext) -- [onData](SrtpSession.md#ondata) -- [remoteContext](SrtpSession.md#remotecontext) +# Class: SrtpSession -### Methods +## Extends -- [decrypt](SrtpSession.md#decrypt) -- [encrypt](SrtpSession.md#encrypt) -- [start](SrtpSession.md#start) +- `Session`\<`SrtpContext`\> ## Constructors -### constructor +### new SrtpSession() -• **new SrtpSession**(`config`): [`SrtpSession`](SrtpSession.md) +> **new SrtpSession**(`config`): [`SrtpSession`](SrtpSession.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `config` | `Config` | +• **config**: `Config` #### Returns @@ -45,106 +26,99 @@ #### Overrides -Session\<SrtpContext\>.constructor +`Session.constructor` ## Properties ### config -• **config**: `Config` +> **config**: `Config` -___ +*** ### localContext -• **localContext**: `SrtpContext` +> **localContext**: `SrtpContext` #### Inherited from -Session.localContext - -___ - -### onData +`Session.localContext` -• `Optional` **onData**: (`buf`: `Buffer`) => `void` +*** -#### Type declaration +### onData()? -▸ (`buf`): `void` +> `optional` **onData**: (`buf`) => `void` -##### Parameters +#### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` -##### Returns +#### Returns `void` #### Inherited from -Session.onData +`Session.onData` -___ +*** ### remoteContext -• **remoteContext**: `SrtpContext` +> **remoteContext**: `SrtpContext` #### Inherited from -Session.remoteContext +`Session.remoteContext` ## Methods -### decrypt +### decrypt() -▸ **decrypt**(`buf`): `Buffer` +> **decrypt**(`buf`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns `Buffer` -___ +*** -### encrypt +### encrypt() -▸ **encrypt**(`payload`, `header`): `Buffer` +> **encrypt**(`payload`, `header`): `Buffer` #### Parameters -| Name | Type | -| :------ | :------ | -| `payload` | `Buffer` | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **payload**: `Buffer` + +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns `Buffer` -___ +*** -### start +### start() -▸ **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` +> **start**(`localMasterKey`, `localMasterSalt`, `remoteMasterKey`, `remoteMasterSalt`, `profile`): `void` #### Parameters -| Name | Type | -| :------ | :------ | -| `localMasterKey` | `Buffer` | -| `localMasterSalt` | `Buffer` | -| `remoteMasterKey` | `Buffer` | -| `remoteMasterSalt` | `Buffer` | -| `profile` | `number` | +• **localMasterKey**: `Buffer` + +• **localMasterSalt**: `Buffer` + +• **remoteMasterKey**: `Buffer` + +• **remoteMasterSalt**: `Buffer` + +• **profile**: `number` #### Returns @@ -152,4 +126,4 @@ ___ #### Inherited from -Session.start +`Session.start` diff --git a/packages/rtp/doc/classes/StatusVectorChunk.md b/packages/rtp/doc/classes/StatusVectorChunk.md index 84504568d..27557028a 100644 --- a/packages/rtp/doc/classes/StatusVectorChunk.md +++ b/packages/rtp/doc/classes/StatusVectorChunk.md @@ -1,35 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / StatusVectorChunk +[**werift-rtp**](../README.md) • **Docs** -# Class: StatusVectorChunk - -## Table of contents - -### Constructors - -- [constructor](StatusVectorChunk.md#constructor) +*** -### Properties +[werift-rtp](../globals.md) / StatusVectorChunk -- [symbolList](StatusVectorChunk.md#symbollist) -- [symbolSize](StatusVectorChunk.md#symbolsize) -- [type](StatusVectorChunk.md#type) - -### Methods - -- [serialize](StatusVectorChunk.md#serialize) -- [deSerialize](StatusVectorChunk.md#deserialize) +# Class: StatusVectorChunk ## Constructors -### constructor +### new StatusVectorChunk() -• **new StatusVectorChunk**(`props?`): [`StatusVectorChunk`](StatusVectorChunk.md) +> **new StatusVectorChunk**(`props`): [`StatusVectorChunk`](StatusVectorChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`StatusVectorChunk`](StatusVectorChunk.md)\> | +• **props**: `Partial`\<[`StatusVectorChunk`](StatusVectorChunk.md)\> = `{}` #### Returns @@ -39,41 +24,39 @@ ### symbolList -• **symbolList**: `number`[] = `[]` +> **symbolList**: `number`[] = `[]` -___ +*** ### symbolSize -• **symbolSize**: `number` +> **symbolSize**: `number` -___ +*** ### type -• **type**: `number` +> **type**: `number` ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`): [`StatusVectorChunk`](StatusVectorChunk.md) +> `static` **deSerialize**(`data`): [`StatusVectorChunk`](StatusVectorChunk.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | +• **data**: `Buffer` #### Returns diff --git a/packages/rtp/doc/classes/TransportWideCC.md b/packages/rtp/doc/classes/TransportWideCC.md index 946fed8a9..a603e13e0 100644 --- a/packages/rtp/doc/classes/TransportWideCC.md +++ b/packages/rtp/doc/classes/TransportWideCC.md @@ -1,48 +1,20 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / TransportWideCC +[**werift-rtp**](../README.md) • **Docs** -# Class: TransportWideCC - -## Table of contents - -### Constructors - -- [constructor](TransportWideCC.md#constructor) - -### Properties - -- [baseSequenceNumber](TransportWideCC.md#basesequencenumber) -- [count](TransportWideCC.md#count) -- [fbPktCount](TransportWideCC.md#fbpktcount) -- [header](TransportWideCC.md#header) -- [length](TransportWideCC.md#length) -- [mediaSourceSsrc](TransportWideCC.md#mediasourcessrc) -- [packetChunks](TransportWideCC.md#packetchunks) -- [packetStatusCount](TransportWideCC.md#packetstatuscount) -- [recvDeltas](TransportWideCC.md#recvdeltas) -- [referenceTime](TransportWideCC.md#referencetime) -- [senderSsrc](TransportWideCC.md#senderssrc) -- [count](TransportWideCC.md#count-1) +*** -### Accessors +[werift-rtp](../globals.md) / TransportWideCC -- [packetResults](TransportWideCC.md#packetresults) - -### Methods - -- [serialize](TransportWideCC.md#serialize) -- [deSerialize](TransportWideCC.md#deserialize) +# Class: TransportWideCC ## Constructors -### constructor +### new TransportWideCC() -• **new TransportWideCC**(`props?`): [`TransportWideCC`](TransportWideCC.md) +> **new TransportWideCC**(`props`): [`TransportWideCC`](TransportWideCC.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Partial`\<[`TransportWideCC`](TransportWideCC.md)\> | +• **props**: `Partial`\<[`TransportWideCC`](TransportWideCC.md)\> = `{}` #### Returns @@ -52,81 +24,81 @@ ### baseSequenceNumber -• **baseSequenceNumber**: `number` +> **baseSequenceNumber**: `number` -___ +*** ### count -• **count**: `number` = `TransportWideCC.count` +> **count**: `number` = `TransportWideCC.count` -___ +*** ### fbPktCount -• **fbPktCount**: `number` +> **fbPktCount**: `number` -___ +*** ### header -• **header**: [`RtcpHeader`](RtcpHeader.md) +> **header**: [`RtcpHeader`](RtcpHeader.md) -___ +*** ### length -• **length**: `number` = `2` +> **length**: `number` = `2` -___ +*** ### mediaSourceSsrc -• **mediaSourceSsrc**: `number` +> **mediaSourceSsrc**: `number` -___ +*** ### packetChunks -• **packetChunks**: ([`RunLengthChunk`](RunLengthChunk.md) \| [`StatusVectorChunk`](StatusVectorChunk.md))[] = `[]` +> **packetChunks**: ([`RunLengthChunk`](RunLengthChunk.md) \| [`StatusVectorChunk`](StatusVectorChunk.md))[] = `[]` -___ +*** ### packetStatusCount -• **packetStatusCount**: `number` +> **packetStatusCount**: `number` -___ +*** ### recvDeltas -• **recvDeltas**: [`RecvDelta`](RecvDelta.md)[] = `[]` +> **recvDeltas**: [`RecvDelta`](RecvDelta.md)[] = `[]` -___ +*** ### referenceTime -• **referenceTime**: `number` +> **referenceTime**: `number` 24bit multiples of 64ms -___ +*** ### senderSsrc -• **senderSsrc**: `number` +> **senderSsrc**: `number` -___ +*** ### count -▪ `Static` **count**: `number` = `15` +> `static` **count**: `number` = `15` ## Accessors ### packetResults -• `get` **packetResults**(): [`PacketResult`](PacketResult.md)[] +> `get` **packetResults**(): [`PacketResult`](PacketResult.md)[] #### Returns @@ -134,26 +106,25 @@ ___ ## Methods -### serialize +### serialize() -▸ **serialize**(): `Buffer` +> **serialize**(): `Buffer` #### Returns `Buffer` -___ +*** -### deSerialize +### deSerialize() -▸ **deSerialize**(`data`, `header`): [`TransportWideCC`](TransportWideCC.md) +> `static` **deSerialize**(`data`, `header`): [`TransportWideCC`](TransportWideCC.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `header` | [`RtcpHeader`](RtcpHeader.md) | +• **data**: `Buffer` + +• **header**: [`RtcpHeader`](RtcpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/Vp8RtpPayload.md b/packages/rtp/doc/classes/Vp8RtpPayload.md index 9f80f3ebf..58402f02f 100644 --- a/packages/rtp/doc/classes/Vp8RtpPayload.md +++ b/packages/rtp/doc/classes/Vp8RtpPayload.md @@ -1,4 +1,8 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / Vp8RtpPayload +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / Vp8RtpPayload # Class: Vp8RtpPayload @@ -6,49 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](Vp8RtpPayload.md#constructor) - -### Properties - -- [hBit](Vp8RtpPayload.md#hbit) -- [iBit](Vp8RtpPayload.md#ibit) -- [kBit](Vp8RtpPayload.md#kbit) -- [lBit](Vp8RtpPayload.md#lbit) -- [mBit](Vp8RtpPayload.md#mbit) -- [nBit](Vp8RtpPayload.md#nbit) -- [pBit](Vp8RtpPayload.md#pbit) -- [payload](Vp8RtpPayload.md#payload) -- [pictureId](Vp8RtpPayload.md#pictureid) -- [pid](Vp8RtpPayload.md#pid) -- [sBit](Vp8RtpPayload.md#sbit) -- [size0](Vp8RtpPayload.md#size0) -- [size1](Vp8RtpPayload.md#size1) -- [size2](Vp8RtpPayload.md#size2) -- [tBit](Vp8RtpPayload.md#tbit) -- [ver](Vp8RtpPayload.md#ver) -- [xBit](Vp8RtpPayload.md#xbit) - -### Accessors - -- [isKeyframe](Vp8RtpPayload.md#iskeyframe) -- [isPartitionHead](Vp8RtpPayload.md#ispartitionhead) -- [payloadHeaderExist](Vp8RtpPayload.md#payloadheaderexist) -- [size](Vp8RtpPayload.md#size) - -### Methods - -- [deSerialize](Vp8RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](Vp8RtpPayload.md#isdetectedfinalpacketinsequence) - ## Constructors -### constructor +### new Vp8RtpPayload() -• **new Vp8RtpPayload**(): [`Vp8RtpPayload`](Vp8RtpPayload.md) +> **new Vp8RtpPayload**(): [`Vp8RtpPayload`](Vp8RtpPayload.md) #### Returns @@ -56,115 +22,115 @@ ## Properties -### hBit +### hBit? -• `Optional` **hBit**: `number` +> `optional` **hBit**: `number` -___ +*** -### iBit +### iBit? -• `Optional` **iBit**: `number` +> `optional` **iBit**: `number` -___ +*** -### kBit +### kBit? -• `Optional` **kBit**: `number` +> `optional` **kBit**: `number` -___ +*** -### lBit +### lBit? -• `Optional` **lBit**: `number` +> `optional` **lBit**: `number` -___ +*** -### mBit +### mBit? -• `Optional` **mBit**: `number` +> `optional` **mBit**: `number` -___ +*** ### nBit -• **nBit**: `number` +> **nBit**: `number` -___ +*** -### pBit +### pBit? -• `Optional` **pBit**: `number` +> `optional` **pBit**: `number` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** -### pictureId +### pictureId? -• `Optional` **pictureId**: `number` +> `optional` **pictureId**: `number` -___ +*** ### pid -• **pid**: `number` +> **pid**: `number` -___ +*** ### sBit -• **sBit**: `number` +> **sBit**: `number` -___ +*** ### size0 -• **size0**: `number` = `0` +> **size0**: `number` = `0` -___ +*** ### size1 -• **size1**: `number` = `0` +> **size1**: `number` = `0` -___ +*** ### size2 -• **size2**: `number` = `0` +> **size2**: `number` = `0` -___ +*** -### tBit +### tBit? -• `Optional` **tBit**: `number` +> `optional` **tBit**: `number` -___ +*** -### ver +### ver? -• `Optional` **ver**: `number` +> `optional` **ver**: `number` -___ +*** ### xBit -• **xBit**: `number` +> **xBit**: `number` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -172,33 +138,33 @@ ___ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` +> `get` **isPartitionHead**(): `boolean` #### Returns `boolean` -___ +*** ### payloadHeaderExist -• `get` **payloadHeaderExist**(): `boolean` +> `get` **payloadHeaderExist**(): `boolean` #### Returns `boolean` -___ +*** ### size -• `get` **size**(): `number` +> `get` **size**(): `number` #### Returns @@ -206,31 +172,27 @@ ___ ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`Vp8RtpPayload`](Vp8RtpPayload.md) +> `static` **deSerialize**(`buf`): [`Vp8RtpPayload`](Vp8RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`Vp8RtpPayload`](Vp8RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns diff --git a/packages/rtp/doc/classes/Vp9RtpPayload.md b/packages/rtp/doc/classes/Vp9RtpPayload.md index 765fcbda5..b9a096bf9 100644 --- a/packages/rtp/doc/classes/Vp9RtpPayload.md +++ b/packages/rtp/doc/classes/Vp9RtpPayload.md @@ -1,4 +1,8 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / Vp9RtpPayload +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / Vp9RtpPayload # Class: Vp9RtpPayload @@ -6,57 +10,11 @@ - [`DePacketizerBase`](DePacketizerBase.md) -## Table of contents - -### Constructors - -- [constructor](Vp9RtpPayload.md#constructor) - -### Properties - -- [bBit](Vp9RtpPayload.md#bbit) -- [d](Vp9RtpPayload.md#d) -- [eBit](Vp9RtpPayload.md#ebit) -- [fBit](Vp9RtpPayload.md#fbit) -- [g](Vp9RtpPayload.md#g) -- [height](Vp9RtpPayload.md#height) -- [iBit](Vp9RtpPayload.md#ibit) -- [lBit](Vp9RtpPayload.md#lbit) -- [m](Vp9RtpPayload.md#m) -- [n\_g](Vp9RtpPayload.md#n_g) -- [n\_s](Vp9RtpPayload.md#n_s) -- [pBit](Vp9RtpPayload.md#pbit) -- [pDiff](Vp9RtpPayload.md#pdiff) -- [payload](Vp9RtpPayload.md#payload) -- [pgP\_Diff](Vp9RtpPayload.md#pgp_diff) -- [pgT](Vp9RtpPayload.md#pgt) -- [pgU](Vp9RtpPayload.md#pgu) -- [pictureId](Vp9RtpPayload.md#pictureid) -- [sid](Vp9RtpPayload.md#sid) -- [tid](Vp9RtpPayload.md#tid) -- [tl0PicIdx](Vp9RtpPayload.md#tl0picidx) -- [u](Vp9RtpPayload.md#u) -- [vBit](Vp9RtpPayload.md#vbit) -- [width](Vp9RtpPayload.md#width) -- [y](Vp9RtpPayload.md#y) -- [zBit](Vp9RtpPayload.md#zbit) - -### Accessors - -- [isKeyframe](Vp9RtpPayload.md#iskeyframe) -- [isPartitionHead](Vp9RtpPayload.md#ispartitionhead) - -### Methods - -- [deSerialize](Vp9RtpPayload.md#deserialize) -- [isDetectedFinalPacketInSequence](Vp9RtpPayload.md#isdetectedfinalpacketinsequence) -- [parseRtpPayload](Vp9RtpPayload.md#parsertppayload) - ## Constructors -### constructor +### new Vp9RtpPayload() -• **new Vp9RtpPayload**(): [`Vp9RtpPayload`](Vp9RtpPayload.md) +> **new Vp9RtpPayload**(): [`Vp9RtpPayload`](Vp9RtpPayload.md) #### Returns @@ -66,183 +24,183 @@ ### bBit -• **bBit**: `number` +> **bBit**: `number` Start of a frame -___ +*** -### d +### d? -• `Optional` **d**: `number` +> `optional` **d**: `number` inter_layer_predicted -___ +*** ### eBit -• **eBit**: `number` +> **eBit**: `number` End of a frame -___ +*** ### fBit -• **fBit**: `number` +> **fBit**: `number` Flexible mode -___ +*** -### g +### g? -• `Optional` **g**: `number` +> `optional` **g**: `number` -___ +*** ### height -• **height**: `number`[] = `[]` +> **height**: `number`[] = `[]` -___ +*** ### iBit -• **iBit**: `number` +> **iBit**: `number` Picture ID (PID) present -___ +*** ### lBit -• **lBit**: `number` +> **lBit**: `number` Layer indices present -___ +*** -### m +### m? -• `Optional` **m**: `number` +> `optional` **m**: `number` -___ +*** ### n\_g -• **n\_g**: `number` = `0` +> **n\_g**: `number` = `0` -___ +*** -### n\_s +### n\_s? -• `Optional` **n\_s**: `number` +> `optional` **n\_s**: `number` -___ +*** ### pBit -• **pBit**: `number` +> **pBit**: `number` Inter-picture predicted frame -___ +*** ### pDiff -• **pDiff**: `number`[] = `[]` +> **pDiff**: `number`[] = `[]` -___ +*** ### payload -• **payload**: `Buffer` +> **payload**: `Buffer` #### Implementation of -[DePacketizerBase](DePacketizerBase.md).[payload](DePacketizerBase.md#payload) +[`DePacketizerBase`](DePacketizerBase.md).[`payload`](DePacketizerBase.md#payload) -___ +*** ### pgP\_Diff -• **pgP\_Diff**: `number`[][] = `[]` +> **pgP\_Diff**: `number`[][] = `[]` -___ +*** ### pgT -• **pgT**: `number`[] = `[]` +> **pgT**: `number`[] = `[]` -___ +*** ### pgU -• **pgU**: `number`[] = `[]` +> **pgU**: `number`[] = `[]` -___ +*** -### pictureId +### pictureId? -• `Optional` **pictureId**: `number` +> `optional` **pictureId**: `number` -___ +*** -### sid +### sid? -• `Optional` **sid**: `number` +> `optional` **sid**: `number` -___ +*** -### tid +### tid? -• `Optional` **tid**: `number` +> `optional` **tid**: `number` -___ +*** -### tl0PicIdx +### tl0PicIdx? -• `Optional` **tl0PicIdx**: `number` +> `optional` **tl0PicIdx**: `number` -___ +*** -### u +### u? -• `Optional` **u**: `number` +> `optional` **u**: `number` -___ +*** ### vBit -• **vBit**: `number` +> **vBit**: `number` Scalability structure -___ +*** ### width -• **width**: `number`[] = `[]` +> **width**: `number`[] = `[]` -___ +*** -### y +### y? -• `Optional` **y**: `number` +> `optional` **y**: `number` -___ +*** ### zBit -• **zBit**: `number` +> **zBit**: `number` ## Accessors ### isKeyframe -• `get` **isKeyframe**(): `boolean` +> `get` **isKeyframe**(): `boolean` #### Returns @@ -250,67 +208,64 @@ ___ #### Implementation of -DePacketizerBase.isKeyframe +[`DePacketizerBase`](DePacketizerBase.md).[`isKeyframe`](DePacketizerBase.md#iskeyframe) -___ +*** ### isPartitionHead -• `get` **isPartitionHead**(): `boolean` \| ``0`` +> `get` **isPartitionHead**(): `boolean` \| `0` #### Returns -`boolean` \| ``0`` +`boolean` \| `0` ## Methods -### deSerialize +### deSerialize() -▸ **deSerialize**(`buf`): [`Vp9RtpPayload`](Vp9RtpPayload.md) +> `static` **deSerialize**(`buf`): [`Vp9RtpPayload`](Vp9RtpPayload.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns [`Vp9RtpPayload`](Vp9RtpPayload.md) -___ +*** -### isDetectedFinalPacketInSequence +### isDetectedFinalPacketInSequence() -▸ **isDetectedFinalPacketInSequence**(`header`): `boolean` +> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean` #### Parameters -| Name | Type | -| :------ | :------ | -| `header` | [`RtpHeader`](RtpHeader.md) | +• **header**: [`RtpHeader`](RtpHeader.md) #### Returns `boolean` -___ +*** -### parseRtpPayload +### parseRtpPayload() -▸ **parseRtpPayload**(`buf`): `Object` +> `static` **parseRtpPayload**(`buf`): `object` #### Parameters -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | +• **buf**: `Buffer` #### Returns -`Object` +`object` + +##### offset + +> **offset**: `number` + +##### p -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `p` | [`Vp9RtpPayload`](Vp9RtpPayload.md) | +> **p**: [`Vp9RtpPayload`](Vp9RtpPayload.md) diff --git a/packages/rtp/doc/classes/WeriftError.md b/packages/rtp/doc/classes/WeriftError.md index e186c14b9..4493d4362 100644 --- a/packages/rtp/doc/classes/WeriftError.md +++ b/packages/rtp/doc/classes/WeriftError.md @@ -1,46 +1,24 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / WeriftError +[**werift-rtp**](../README.md) • **Docs** -# Class: WeriftError - -## Hierarchy - -- `Error` - - ↳ **`WeriftError`** - -## Table of contents +*** -### Constructors +[werift-rtp](../globals.md) / WeriftError -- [constructor](WeriftError.md#constructor) - -### Properties - -- [cause](WeriftError.md#cause) -- [message](WeriftError.md#message) -- [name](WeriftError.md#name) -- [path](WeriftError.md#path) -- [payload](WeriftError.md#payload) -- [stack](WeriftError.md#stack) -- [prepareStackTrace](WeriftError.md#preparestacktrace) -- [stackTraceLimit](WeriftError.md#stacktracelimit) +# Class: WeriftError -### Methods +## Extends -- [toJSON](WeriftError.md#tojson) -- [captureStackTrace](WeriftError.md#capturestacktrace) +- `Error` ## Constructors -### constructor +### new WeriftError() -• **new WeriftError**(`props`): [`WeriftError`](WeriftError.md) +> **new WeriftError**(`props`): [`WeriftError`](WeriftError.md) #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Pick`\<[`WeriftError`](WeriftError.md), ``"message"`` \| ``"payload"`` \| ``"path"``\> | +• **props**: `Pick`\<[`WeriftError`](WeriftError.md), `"message"` \| `"payload"` \| `"path"`\> #### Returns @@ -48,137 +26,131 @@ #### Overrides -Error.constructor +`Error.constructor` ## Properties -### cause +### cause? -• `Optional` **cause**: `unknown` +> `optional` **cause**: `unknown` #### Inherited from -Error.cause +`Error.cause` -___ +*** ### message -• **message**: `string` +> **message**: `string` #### Overrides -Error.message +`Error.message` -___ +*** ### name -• **name**: `string` +> **name**: `string` #### Inherited from -Error.name +`Error.name` -___ +*** -### path +### path? -• `Optional` **path**: `string` +> `optional` **path**: `string` -___ +*** -### payload +### payload? -• `Optional` **payload**: `object` +> `optional` **payload**: `object` -___ +*** -### stack +### stack? -• `Optional` **stack**: `string` +> `optional` **stack**: `string` #### Inherited from -Error.stack +`Error.stack` -___ +*** -### prepareStackTrace +### prepareStackTrace()? -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` +> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` Optional override for formatting stack traces -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces +#### Parameters -##### Parameters +• **err**: `Error` -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | +• **stackTraces**: `CallSite`[] -##### Returns +#### Returns `any` -**`See`** +#### See https://v8.dev/docs/stack-trace-api#customizing-stack-traces #### Inherited from -Error.prepareStackTrace +`Error.prepareStackTrace` -___ +*** ### stackTraceLimit -▪ `Static` **stackTraceLimit**: `number` +> `static` **stackTraceLimit**: `number` #### Inherited from -Error.stackTraceLimit +`Error.stackTraceLimit` ## Methods -### toJSON +### toJSON() -▸ **toJSON**(): `Object` +> **toJSON**(): `object` #### Returns -`Object` +`object` -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `path` | `undefined` \| `string` | -| `payload` | `any` | +##### message -___ +> **message**: `string` -### captureStackTrace +##### path -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` +> **path**: `undefined` \| `string` + +##### payload + +> **payload**: `any` + +*** + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` Create .stack property on a target object #### Parameters -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | +• **targetObject**: `object` + +• **constructorOpt?**: `Function` #### Returns @@ -186,4 +158,4 @@ Create .stack property on a target object #### Inherited from -Error.captureStackTrace +`Error.captureStackTrace` diff --git a/packages/rtp/doc/enumerations/PacketChunk.md b/packages/rtp/doc/enumerations/PacketChunk.md new file mode 100644 index 000000000..2761effb7 --- /dev/null +++ b/packages/rtp/doc/enumerations/PacketChunk.md @@ -0,0 +1,25 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / PacketChunk + +# Enumeration: PacketChunk + +## Enumeration Members + +### TypeTCCRunLengthChunk + +> **TypeTCCRunLengthChunk**: `0` + +*** + +### TypeTCCStatusVectorChunk + +> **TypeTCCStatusVectorChunk**: `1` + +*** + +### packetStatusChunkLength + +> **packetStatusChunkLength**: `2` diff --git a/packages/rtp/doc/enumerations/PacketStatus.md b/packages/rtp/doc/enumerations/PacketStatus.md new file mode 100644 index 000000000..b54bb7f50 --- /dev/null +++ b/packages/rtp/doc/enumerations/PacketStatus.md @@ -0,0 +1,31 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / PacketStatus + +# Enumeration: PacketStatus + +## Enumeration Members + +### TypeTCCPacketNotReceived + +> **TypeTCCPacketNotReceived**: `0` + +*** + +### TypeTCCPacketReceivedLargeDelta + +> **TypeTCCPacketReceivedLargeDelta**: `2` + +*** + +### TypeTCCPacketReceivedSmallDelta + +> **TypeTCCPacketReceivedSmallDelta**: `1` + +*** + +### TypeTCCPacketReceivedWithoutDelta + +> **TypeTCCPacketReceivedWithoutDelta**: `3` diff --git a/packages/rtp/doc/enums/PacketChunk.md b/packages/rtp/doc/enums/PacketChunk.md deleted file mode 100644 index 36cf2e4e4..000000000 --- a/packages/rtp/doc/enums/PacketChunk.md +++ /dev/null @@ -1,29 +0,0 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / PacketChunk - -# Enumeration: PacketChunk - -## Table of contents - -### Enumeration Members - -- [TypeTCCRunLengthChunk](PacketChunk.md#typetccrunlengthchunk) -- [TypeTCCStatusVectorChunk](PacketChunk.md#typetccstatusvectorchunk) -- [packetStatusChunkLength](PacketChunk.md#packetstatuschunklength) - -## Enumeration Members - -### TypeTCCRunLengthChunk - -• **TypeTCCRunLengthChunk** = ``0`` - -___ - -### TypeTCCStatusVectorChunk - -• **TypeTCCStatusVectorChunk** = ``1`` - -___ - -### packetStatusChunkLength - -• **packetStatusChunkLength** = ``2`` diff --git a/packages/rtp/doc/enums/PacketStatus.md b/packages/rtp/doc/enums/PacketStatus.md deleted file mode 100644 index af9448688..000000000 --- a/packages/rtp/doc/enums/PacketStatus.md +++ /dev/null @@ -1,36 +0,0 @@ -[werift-rtp](../README.md) / [Exports](../modules.md) / PacketStatus - -# Enumeration: PacketStatus - -## Table of contents - -### Enumeration Members - -- [TypeTCCPacketNotReceived](PacketStatus.md#typetccpacketnotreceived) -- [TypeTCCPacketReceivedLargeDelta](PacketStatus.md#typetccpacketreceivedlargedelta) -- [TypeTCCPacketReceivedSmallDelta](PacketStatus.md#typetccpacketreceivedsmalldelta) -- [TypeTCCPacketReceivedWithoutDelta](PacketStatus.md#typetccpacketreceivedwithoutdelta) - -## Enumeration Members - -### TypeTCCPacketNotReceived - -• **TypeTCCPacketNotReceived** = ``0`` - -___ - -### TypeTCCPacketReceivedLargeDelta - -• **TypeTCCPacketReceivedLargeDelta** = ``2`` - -___ - -### TypeTCCPacketReceivedSmallDelta - -• **TypeTCCPacketReceivedSmallDelta** = ``1`` - -___ - -### TypeTCCPacketReceivedWithoutDelta - -• **TypeTCCPacketReceivedWithoutDelta** = ``3`` diff --git a/packages/rtp/doc/functions/Int.md b/packages/rtp/doc/functions/Int.md new file mode 100644 index 000000000..d71edc0a6 --- /dev/null +++ b/packages/rtp/doc/functions/Int.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / Int + +# Function: Int() + +> **Int**(`v`): `number` + +## Parameters + +• **v**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/buffer2ArrayBuffer.md b/packages/rtp/doc/functions/buffer2ArrayBuffer.md new file mode 100644 index 000000000..87acee641 --- /dev/null +++ b/packages/rtp/doc/functions/buffer2ArrayBuffer.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / buffer2ArrayBuffer + +# Function: buffer2ArrayBuffer() + +> **buffer2ArrayBuffer**(`buf`): `ArrayBuffer` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`ArrayBuffer` diff --git a/packages/rtp/doc/functions/bufferArrayXor.md b/packages/rtp/doc/functions/bufferArrayXor.md new file mode 100644 index 000000000..73d2378a9 --- /dev/null +++ b/packages/rtp/doc/functions/bufferArrayXor.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / bufferArrayXor + +# Function: bufferArrayXor() + +> **bufferArrayXor**(`arr`): `Buffer` + +## Parameters + +• **arr**: `Buffer`[] + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/bufferReader.md b/packages/rtp/doc/functions/bufferReader.md new file mode 100644 index 000000000..216815381 --- /dev/null +++ b/packages/rtp/doc/functions/bufferReader.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / bufferReader + +# Function: bufferReader() + +> **bufferReader**(`buf`, `bytes`): `any`[] + +## Parameters + +• **buf**: `Buffer` + +• **bytes**: `number`[] + +## Returns + +`any`[] diff --git a/packages/rtp/doc/functions/bufferWriter.md b/packages/rtp/doc/functions/bufferWriter.md new file mode 100644 index 000000000..8315f8ccd --- /dev/null +++ b/packages/rtp/doc/functions/bufferWriter.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / bufferWriter + +# Function: bufferWriter() + +> **bufferWriter**(`bytes`, `values`): `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **values**: (`number` \| `bigint`)[] + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/bufferWriterLE.md b/packages/rtp/doc/functions/bufferWriterLE.md new file mode 100644 index 000000000..467a3093f --- /dev/null +++ b/packages/rtp/doc/functions/bufferWriterLE.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / bufferWriterLE + +# Function: bufferWriterLE() + +> **bufferWriterLE**(`bytes`, `values`): `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **values**: (`number` \| `bigint`)[] + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/bufferXor.md b/packages/rtp/doc/functions/bufferXor.md new file mode 100644 index 000000000..787b13b36 --- /dev/null +++ b/packages/rtp/doc/functions/bufferXor.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / bufferXor + +# Function: bufferXor() + +> **bufferXor**(`a`, `b`): `Buffer` + +## Parameters + +• **a**: `Buffer` + +• **b**: `Buffer` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/createBufferWriter.md b/packages/rtp/doc/functions/createBufferWriter.md new file mode 100644 index 000000000..8dd613713 --- /dev/null +++ b/packages/rtp/doc/functions/createBufferWriter.md @@ -0,0 +1,27 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / createBufferWriter + +# Function: createBufferWriter() + +> **createBufferWriter**(`bytes`, `singleBuffer`?): (`values`) => `Buffer` + +## Parameters + +• **bytes**: `number`[] + +• **singleBuffer?**: `boolean` + +## Returns + +`Function` + +### Parameters + +• **values**: (`number` \| `bigint`)[] + +### Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/dePacketizeRtpPackets.md b/packages/rtp/doc/functions/dePacketizeRtpPackets.md new file mode 100644 index 000000000..fbe67f92d --- /dev/null +++ b/packages/rtp/doc/functions/dePacketizeRtpPackets.md @@ -0,0 +1,41 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / dePacketizeRtpPackets + +# Function: dePacketizeRtpPackets() + +> **dePacketizeRtpPackets**(`codec`, `packets`, `frameFragmentBuffer`?): `object` + +## Parameters + +• **codec**: [`DepacketizerCodec`](../type-aliases/DepacketizerCodec.md) + +• **packets**: [`RtpPacket`](../classes/RtpPacket.md)[] + +• **frameFragmentBuffer?**: `Buffer` + +## Returns + +`object` + +### data + +> **data**: `Buffer` + +### frameFragmentBuffer? + +> `optional` **frameFragmentBuffer**: `Buffer` + +### isKeyframe + +> **isKeyframe**: `boolean` + +### sequence + +> **sequence**: `number` + +### timestamp + +> **timestamp**: `number` diff --git a/packages/rtp/doc/functions/deserializeAbsSendTime.md b/packages/rtp/doc/functions/deserializeAbsSendTime.md new file mode 100644 index 000000000..7c3ace335 --- /dev/null +++ b/packages/rtp/doc/functions/deserializeAbsSendTime.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / deserializeAbsSendTime + +# Function: deserializeAbsSendTime() + +> **deserializeAbsSendTime**(`buf`): `any` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`any` diff --git a/packages/rtp/doc/functions/deserializeAudioLevelIndication.md b/packages/rtp/doc/functions/deserializeAudioLevelIndication.md new file mode 100644 index 000000000..2a5c41253 --- /dev/null +++ b/packages/rtp/doc/functions/deserializeAudioLevelIndication.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / deserializeAudioLevelIndication + +# Function: deserializeAudioLevelIndication() + +> **deserializeAudioLevelIndication**(`buf`): [`AudioLevelIndicationPayload`](../type-aliases/AudioLevelIndicationPayload.md) + +## Parameters + +• **buf**: `Buffer` + +## Returns + +[`AudioLevelIndicationPayload`](../type-aliases/AudioLevelIndicationPayload.md) diff --git a/packages/rtp/doc/functions/deserializeString.md b/packages/rtp/doc/functions/deserializeString.md new file mode 100644 index 000000000..1d44b4bb0 --- /dev/null +++ b/packages/rtp/doc/functions/deserializeString.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / deserializeString + +# Function: deserializeString() + +> **deserializeString**(`buf`): `string` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`string` diff --git a/packages/rtp/doc/functions/deserializeUint16BE.md b/packages/rtp/doc/functions/deserializeUint16BE.md new file mode 100644 index 000000000..1502065d2 --- /dev/null +++ b/packages/rtp/doc/functions/deserializeUint16BE.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / deserializeUint16BE + +# Function: deserializeUint16BE() + +> **deserializeUint16BE**(`buf`): `number` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/dumpBuffer.md b/packages/rtp/doc/functions/dumpBuffer.md new file mode 100644 index 000000000..d77c5ad91 --- /dev/null +++ b/packages/rtp/doc/functions/dumpBuffer.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / dumpBuffer + +# Function: dumpBuffer() + +> **dumpBuffer**(`data`): `string` + +## Parameters + +• **data**: `Buffer` + +## Returns + +`string` diff --git a/packages/rtp/doc/functions/enumerate.md b/packages/rtp/doc/functions/enumerate.md new file mode 100644 index 000000000..a21a6f860 --- /dev/null +++ b/packages/rtp/doc/functions/enumerate.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / enumerate + +# Function: enumerate() + +> **enumerate**\<`T`\>(`arr`): [`number`, `T`][] + +## Type Parameters + +• **T** + +## Parameters + +• **arr**: `T`[] + +## Returns + +[`number`, `T`][] diff --git a/packages/rtp/doc/functions/findPort.md b/packages/rtp/doc/functions/findPort.md new file mode 100644 index 000000000..c5708fd29 --- /dev/null +++ b/packages/rtp/doc/functions/findPort.md @@ -0,0 +1,23 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / findPort + +# Function: findPort() + +> **findPort**(`min`, `max`, `protocol`, `interfaceAddresses`?): `Promise`\<`number`\> + +## Parameters + +• **min**: `number` + +• **max**: `number` + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`\> diff --git a/packages/rtp/doc/functions/getBit.md b/packages/rtp/doc/functions/getBit.md new file mode 100644 index 000000000..2292bfaab --- /dev/null +++ b/packages/rtp/doc/functions/getBit.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / getBit + +# Function: getBit() + +> **getBit**(`bits`, `startIndex`, `length`): `number` + +## Parameters + +• **bits**: `number` + +• **startIndex**: `number` + +• **length**: `number` = `1` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/growBufferSize.md b/packages/rtp/doc/functions/growBufferSize.md new file mode 100644 index 000000000..9857cac6b --- /dev/null +++ b/packages/rtp/doc/functions/growBufferSize.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / growBufferSize + +# Function: growBufferSize() + +> **growBufferSize**(`buf`, `size`): `Buffer` + +## Parameters + +• **buf**: `Buffer` + +• **size**: `number` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/int-1.md b/packages/rtp/doc/functions/int-1.md new file mode 100644 index 000000000..852193b8f --- /dev/null +++ b/packages/rtp/doc/functions/int-1.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / int + +# Function: int() + +> **int**(`n`): `number` + +## Parameters + +• **n**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/interfaceAddress.md b/packages/rtp/doc/functions/interfaceAddress.md new file mode 100644 index 000000000..c2a1e2f30 --- /dev/null +++ b/packages/rtp/doc/functions/interfaceAddress.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / interfaceAddress + +# Function: interfaceAddress() + +> **interfaceAddress**(`type`, `interfaceAddresses`): `undefined` \| `string` + +## Parameters + +• **type**: `SocketType` + +• **interfaceAddresses**: `undefined` \| [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`undefined` \| `string` diff --git a/packages/rtp/doc/functions/isMedia.md b/packages/rtp/doc/functions/isMedia.md new file mode 100644 index 000000000..3fba5fe67 --- /dev/null +++ b/packages/rtp/doc/functions/isMedia.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / isMedia + +# Function: isMedia() + +> **isMedia**(`buf`): `boolean` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/isRtcp.md b/packages/rtp/doc/functions/isRtcp.md new file mode 100644 index 000000000..6447e4fd7 --- /dev/null +++ b/packages/rtp/doc/functions/isRtcp.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / isRtcp + +# Function: isRtcp() + +> **isRtcp**(`buf`): `boolean` + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/leb128decode.md b/packages/rtp/doc/functions/leb128decode.md new file mode 100644 index 000000000..dd14f4bd1 --- /dev/null +++ b/packages/rtp/doc/functions/leb128decode.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / leb128decode + +# Function: leb128decode() + +> **leb128decode**(`buf`): `number`[] + +## Parameters + +• **buf**: `Buffer` + +## Returns + +`number`[] diff --git a/packages/rtp/doc/functions/ntpTime2Sec.md b/packages/rtp/doc/functions/ntpTime2Sec.md new file mode 100644 index 000000000..b168213ba --- /dev/null +++ b/packages/rtp/doc/functions/ntpTime2Sec.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / ntpTime2Sec + +# Function: ntpTime2Sec() + +> **ntpTime2Sec**(`ntp`): `number` + +## Parameters + +• **ntp**: `bigint` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/paddingBits.md b/packages/rtp/doc/functions/paddingBits.md new file mode 100644 index 000000000..366abea95 --- /dev/null +++ b/packages/rtp/doc/functions/paddingBits.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / paddingBits + +# Function: paddingBits() + +> **paddingBits**(`bits`, `expectLength`): `string` + +## Parameters + +• **bits**: `number` + +• **expectLength**: `number` + +## Returns + +`string` diff --git a/packages/rtp/doc/functions/paddingByte.md b/packages/rtp/doc/functions/paddingByte.md new file mode 100644 index 000000000..c41812b60 --- /dev/null +++ b/packages/rtp/doc/functions/paddingByte.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / paddingByte + +# Function: paddingByte() + +> **paddingByte**(`bits`): `string` + +## Parameters + +• **bits**: `number` + +## Returns + +`string` diff --git a/packages/rtp/doc/functions/random16.md b/packages/rtp/doc/functions/random16.md new file mode 100644 index 000000000..6cc2244ba --- /dev/null +++ b/packages/rtp/doc/functions/random16.md @@ -0,0 +1,13 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / random16 + +# Function: random16() + +> **random16**(): `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/random32.md b/packages/rtp/doc/functions/random32.md new file mode 100644 index 000000000..09968104f --- /dev/null +++ b/packages/rtp/doc/functions/random32.md @@ -0,0 +1,13 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / random32 + +# Function: random32() + +> **random32**(): `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/randomPort.md b/packages/rtp/doc/functions/randomPort.md new file mode 100644 index 000000000..6d9fe4025 --- /dev/null +++ b/packages/rtp/doc/functions/randomPort.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / randomPort + +# Function: randomPort() + +> **randomPort**(`protocol`, `interfaceAddresses`?): `Promise`\<`number`\> + +## Parameters + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`\> diff --git a/packages/rtp/doc/functions/randomPorts.md b/packages/rtp/doc/functions/randomPorts.md new file mode 100644 index 000000000..b651ea0b7 --- /dev/null +++ b/packages/rtp/doc/functions/randomPorts.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / randomPorts + +# Function: randomPorts() + +> **randomPorts**(`num`, `protocol`, `interfaceAddresses`?): `Promise`\<`number`[]\> + +## Parameters + +• **num**: `number` + +• **protocol**: `SocketType` = `"udp4"` + +• **interfaceAddresses?**: [`InterfaceAddresses`](../type-aliases/InterfaceAddresses.md) + +## Returns + +`Promise`\<`number`[]\> diff --git a/packages/rtp/doc/functions/rtpHeaderExtensionsParser.md b/packages/rtp/doc/functions/rtpHeaderExtensionsParser.md new file mode 100644 index 000000000..a21088a84 --- /dev/null +++ b/packages/rtp/doc/functions/rtpHeaderExtensionsParser.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / rtpHeaderExtensionsParser + +# Function: rtpHeaderExtensionsParser() + +> **rtpHeaderExtensionsParser**(`extensions`, `extIdUriMap`): `object` + +## Parameters + +• **extensions**: [`Extension`](../type-aliases/Extension.md)[] + +• **extIdUriMap** + +## Returns + +`object` diff --git a/packages/rtp/doc/functions/serializeAbsSendTime.md b/packages/rtp/doc/functions/serializeAbsSendTime.md new file mode 100644 index 000000000..4f20b5452 --- /dev/null +++ b/packages/rtp/doc/functions/serializeAbsSendTime.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeAbsSendTime + +# Function: serializeAbsSendTime() + +> **serializeAbsSendTime**(`ntpTime`): `Buffer` + +## Parameters + +• **ntpTime**: `bigint` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/serializeAudioLevelIndication.md b/packages/rtp/doc/functions/serializeAudioLevelIndication.md new file mode 100644 index 000000000..f697e205b --- /dev/null +++ b/packages/rtp/doc/functions/serializeAudioLevelIndication.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeAudioLevelIndication + +# Function: serializeAudioLevelIndication() + +> **serializeAudioLevelIndication**(`level`): `Buffer` + +## Parameters + +• **level**: `number` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/serializeRepairedRtpStreamId.md b/packages/rtp/doc/functions/serializeRepairedRtpStreamId.md new file mode 100644 index 000000000..1f17878ed --- /dev/null +++ b/packages/rtp/doc/functions/serializeRepairedRtpStreamId.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeRepairedRtpStreamId + +# Function: serializeRepairedRtpStreamId() + +> **serializeRepairedRtpStreamId**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/serializeSdesMid.md b/packages/rtp/doc/functions/serializeSdesMid.md new file mode 100644 index 000000000..280ecffd6 --- /dev/null +++ b/packages/rtp/doc/functions/serializeSdesMid.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeSdesMid + +# Function: serializeSdesMid() + +> **serializeSdesMid**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/serializeSdesRTPStreamID.md b/packages/rtp/doc/functions/serializeSdesRTPStreamID.md new file mode 100644 index 000000000..7766bdbe6 --- /dev/null +++ b/packages/rtp/doc/functions/serializeSdesRTPStreamID.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeSdesRTPStreamID + +# Function: serializeSdesRTPStreamID() + +> **serializeSdesRTPStreamID**(`id`): `Buffer` + +## Parameters + +• **id**: `string` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/serializeTransportWideCC.md b/packages/rtp/doc/functions/serializeTransportWideCC.md new file mode 100644 index 000000000..5690ba8e0 --- /dev/null +++ b/packages/rtp/doc/functions/serializeTransportWideCC.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / serializeTransportWideCC + +# Function: serializeTransportWideCC() + +> **serializeTransportWideCC**(`transportSequenceNumber`): `Buffer` + +## Parameters + +• **transportSequenceNumber**: `number` + +## Returns + +`Buffer` diff --git a/packages/rtp/doc/functions/uint16Add.md b/packages/rtp/doc/functions/uint16Add.md new file mode 100644 index 000000000..a8535ffd0 --- /dev/null +++ b/packages/rtp/doc/functions/uint16Add.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint16Add + +# Function: uint16Add() + +> **uint16Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/uint16Gt.md b/packages/rtp/doc/functions/uint16Gt.md new file mode 100644 index 000000000..eb65f7f88 --- /dev/null +++ b/packages/rtp/doc/functions/uint16Gt.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint16Gt + +# Function: uint16Gt() + +> **uint16Gt**(`a`, `b`): `boolean` + +Return a > b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/uint16Gte.md b/packages/rtp/doc/functions/uint16Gte.md new file mode 100644 index 000000000..7f4f1a393 --- /dev/null +++ b/packages/rtp/doc/functions/uint16Gte.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint16Gte + +# Function: uint16Gte() + +> **uint16Gte**(`a`, `b`): `boolean` + +Return a >= b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/uint24.md b/packages/rtp/doc/functions/uint24.md new file mode 100644 index 000000000..750ca9a0a --- /dev/null +++ b/packages/rtp/doc/functions/uint24.md @@ -0,0 +1,17 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint24 + +# Function: uint24() + +> **uint24**(`v`): `number` + +## Parameters + +• **v**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/uint32Add.md b/packages/rtp/doc/functions/uint32Add.md new file mode 100644 index 000000000..3e83b1680 --- /dev/null +++ b/packages/rtp/doc/functions/uint32Add.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint32Add + +# Function: uint32Add() + +> **uint32Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/uint32Gt.md b/packages/rtp/doc/functions/uint32Gt.md new file mode 100644 index 000000000..7e2514fe0 --- /dev/null +++ b/packages/rtp/doc/functions/uint32Gt.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint32Gt + +# Function: uint32Gt() + +> **uint32Gt**(`a`, `b`): `boolean` + +Return a > b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/uint32Gte.md b/packages/rtp/doc/functions/uint32Gte.md new file mode 100644 index 000000000..a3da650c5 --- /dev/null +++ b/packages/rtp/doc/functions/uint32Gte.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint32Gte + +# Function: uint32Gte() + +> **uint32Gte**(`a`, `b`): `boolean` + +Return a >= b + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`boolean` diff --git a/packages/rtp/doc/functions/uint8Add.md b/packages/rtp/doc/functions/uint8Add.md new file mode 100644 index 000000000..062c8de7a --- /dev/null +++ b/packages/rtp/doc/functions/uint8Add.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / uint8Add + +# Function: uint8Add() + +> **uint8Add**(`a`, `b`): `number` + +## Parameters + +• **a**: `number` + +• **b**: `number` + +## Returns + +`number` diff --git a/packages/rtp/doc/functions/unwrapRtx.md b/packages/rtp/doc/functions/unwrapRtx.md new file mode 100644 index 000000000..626035786 --- /dev/null +++ b/packages/rtp/doc/functions/unwrapRtx.md @@ -0,0 +1,21 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / unwrapRtx + +# Function: unwrapRtx() + +> **unwrapRtx**(`rtx`, `payloadType`, `ssrc`): [`RtpPacket`](../classes/RtpPacket.md) + +## Parameters + +• **rtx**: [`RtpPacket`](../classes/RtpPacket.md) + +• **payloadType**: `number` + +• **ssrc**: `number` + +## Returns + +[`RtpPacket`](../classes/RtpPacket.md) diff --git a/packages/rtp/doc/functions/wrapRtx.md b/packages/rtp/doc/functions/wrapRtx.md new file mode 100644 index 000000000..39af3dfc2 --- /dev/null +++ b/packages/rtp/doc/functions/wrapRtx.md @@ -0,0 +1,23 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / wrapRtx + +# Function: wrapRtx() + +> **wrapRtx**(`packet`, `payloadType`, `sequenceNumber`, `ssrc`): [`RtpPacket`](../classes/RtpPacket.md) + +## Parameters + +• **packet**: [`RtpPacket`](../classes/RtpPacket.md) + +• **payloadType**: `number` + +• **sequenceNumber**: `number` + +• **ssrc**: `number` + +## Returns + +[`RtpPacket`](../classes/RtpPacket.md) diff --git a/packages/rtp/doc/globals.md b/packages/rtp/doc/globals.md new file mode 100644 index 000000000..8d0838d46 --- /dev/null +++ b/packages/rtp/doc/globals.md @@ -0,0 +1,125 @@ +[**werift-rtp**](README.md) • **Docs** + +*** + +# werift-rtp + +## Enumerations + +- [PacketChunk](enumerations/PacketChunk.md) +- [PacketStatus](enumerations/PacketStatus.md) + +## Classes + +- [AV1Obu](classes/AV1Obu.md) +- [AV1RtpPayload](classes/AV1RtpPayload.md) +- [BitStream](classes/BitStream.md) +- [BitWriter](classes/BitWriter.md) +- [BitWriter2](classes/BitWriter2.md) +- [BufferChain](classes/BufferChain.md) +- [DePacketizerBase](classes/DePacketizerBase.md) +- [Event](classes/Event.md) +- [EventDisposer](classes/EventDisposer.md) +- [GenericNack](classes/GenericNack.md) +- [H264RtpPayload](classes/H264RtpPayload.md) +- [OpusRtpPayload](classes/OpusRtpPayload.md) +- [PacketResult](classes/PacketResult.md) +- [PictureLossIndication](classes/PictureLossIndication.md) +- [PromiseQueue](classes/PromiseQueue.md) +- [ReceiverEstimatedMaxBitrate](classes/ReceiverEstimatedMaxBitrate.md) +- [RecvDelta](classes/RecvDelta.md) +- [Red](classes/Red.md) +- [RedEncoder](classes/RedEncoder.md) +- [RedHandler](classes/RedHandler.md) +- [RedHeader](classes/RedHeader.md) +- [RtcpHeader](classes/RtcpHeader.md) +- [RtcpPacketConverter](classes/RtcpPacketConverter.md) +- [RtcpPayloadSpecificFeedback](classes/RtcpPayloadSpecificFeedback.md) +- [RtcpReceiverInfo](classes/RtcpReceiverInfo.md) +- [RtcpRrPacket](classes/RtcpRrPacket.md) +- [RtcpSenderInfo](classes/RtcpSenderInfo.md) +- [RtcpSourceDescriptionPacket](classes/RtcpSourceDescriptionPacket.md) +- [RtcpSrPacket](classes/RtcpSrPacket.md) +- [RtcpTransportLayerFeedback](classes/RtcpTransportLayerFeedback.md) +- [RtpBuilder](classes/RtpBuilder.md) +- [RtpHeader](classes/RtpHeader.md) +- [RtpPacket](classes/RtpPacket.md) +- [RunLengthChunk](classes/RunLengthChunk.md) +- [SourceDescriptionChunk](classes/SourceDescriptionChunk.md) +- [SourceDescriptionItem](classes/SourceDescriptionItem.md) +- [SrtcpSession](classes/SrtcpSession.md) +- [SrtpSession](classes/SrtpSession.md) +- [StatusVectorChunk](classes/StatusVectorChunk.md) +- [TransportWideCC](classes/TransportWideCC.md) +- [Vp8RtpPayload](classes/Vp8RtpPayload.md) +- [Vp9RtpPayload](classes/Vp9RtpPayload.md) +- [WeriftError](classes/WeriftError.md) + +## Type Aliases + +- [AudioLevelIndicationPayload](type-aliases/AudioLevelIndicationPayload.md) +- [DepacketizerCodec](type-aliases/DepacketizerCodec.md) +- [Extension](type-aliases/Extension.md) +- [InterfaceAddresses](type-aliases/InterfaceAddresses.md) +- [RequireAtLeastOne](type-aliases/RequireAtLeastOne.md) +- [RtcpPacket](type-aliases/RtcpPacket.md) +- [TransportWideCCPayload](type-aliases/TransportWideCCPayload.md) + +## Variables + +- [ExtensionProfiles](variables/ExtensionProfiles.md) +- [NalUnitType](variables/NalUnitType.md) +- [RTCP\_HEADER\_SIZE](variables/RTCP_HEADER_SIZE.md) +- [RTP\_EXTENSION\_URI](variables/RTP_EXTENSION_URI.md) +- [depacketizerCodecs](variables/depacketizerCodecs.md) +- [timer](variables/timer.md) + +## Functions + +- [Int](functions/Int.md) +- [buffer2ArrayBuffer](functions/buffer2ArrayBuffer.md) +- [bufferArrayXor](functions/bufferArrayXor.md) +- [bufferReader](functions/bufferReader.md) +- [bufferWriter](functions/bufferWriter.md) +- [bufferWriterLE](functions/bufferWriterLE.md) +- [bufferXor](functions/bufferXor.md) +- [createBufferWriter](functions/createBufferWriter.md) +- [dePacketizeRtpPackets](functions/dePacketizeRtpPackets.md) +- [deserializeAbsSendTime](functions/deserializeAbsSendTime.md) +- [deserializeAudioLevelIndication](functions/deserializeAudioLevelIndication.md) +- [deserializeString](functions/deserializeString.md) +- [deserializeUint16BE](functions/deserializeUint16BE.md) +- [dumpBuffer](functions/dumpBuffer.md) +- [enumerate](functions/enumerate.md) +- [findPort](functions/findPort.md) +- [getBit](functions/getBit.md) +- [growBufferSize](functions/growBufferSize.md) +- [int](functions/int-1.md) +- [interfaceAddress](functions/interfaceAddress.md) +- [isMedia](functions/isMedia.md) +- [isRtcp](functions/isRtcp.md) +- [leb128decode](functions/leb128decode.md) +- [ntpTime2Sec](functions/ntpTime2Sec.md) +- [paddingBits](functions/paddingBits.md) +- [paddingByte](functions/paddingByte.md) +- [random16](functions/random16.md) +- [random32](functions/random32.md) +- [randomPort](functions/randomPort.md) +- [randomPorts](functions/randomPorts.md) +- [rtpHeaderExtensionsParser](functions/rtpHeaderExtensionsParser.md) +- [serializeAbsSendTime](functions/serializeAbsSendTime.md) +- [serializeAudioLevelIndication](functions/serializeAudioLevelIndication.md) +- [serializeRepairedRtpStreamId](functions/serializeRepairedRtpStreamId.md) +- [serializeSdesMid](functions/serializeSdesMid.md) +- [serializeSdesRTPStreamID](functions/serializeSdesRTPStreamID.md) +- [serializeTransportWideCC](functions/serializeTransportWideCC.md) +- [uint16Add](functions/uint16Add.md) +- [uint16Gt](functions/uint16Gt.md) +- [uint16Gte](functions/uint16Gte.md) +- [uint24](functions/uint24.md) +- [uint32Add](functions/uint32Add.md) +- [uint32Gt](functions/uint32Gt.md) +- [uint32Gte](functions/uint32Gte.md) +- [uint8Add](functions/uint8Add.md) +- [unwrapRtx](functions/unwrapRtx.md) +- [wrapRtx](functions/wrapRtx.md) diff --git a/packages/rtp/doc/modules.md b/packages/rtp/doc/modules.md deleted file mode 100644 index e0ba1a58a..000000000 --- a/packages/rtp/doc/modules.md +++ /dev/null @@ -1,1064 +0,0 @@ -[werift-rtp](README.md) / Exports - -# werift-rtp - -## Table of contents - -### Enumerations - -- [PacketChunk](enums/PacketChunk.md) -- [PacketStatus](enums/PacketStatus.md) - -### Classes - -- [AV1Obu](classes/AV1Obu.md) -- [AV1RtpPayload](classes/AV1RtpPayload.md) -- [BitStream](classes/BitStream.md) -- [BitWriter](classes/BitWriter.md) -- [BitWriter2](classes/BitWriter2.md) -- [BufferChain](classes/BufferChain.md) -- [DePacketizerBase](classes/DePacketizerBase.md) -- [GenericNack](classes/GenericNack.md) -- [H264RtpPayload](classes/H264RtpPayload.md) -- [OpusRtpPayload](classes/OpusRtpPayload.md) -- [PacketResult](classes/PacketResult.md) -- [PictureLossIndication](classes/PictureLossIndication.md) -- [PromiseQueue](classes/PromiseQueue.md) -- [ReceiverEstimatedMaxBitrate](classes/ReceiverEstimatedMaxBitrate.md) -- [RecvDelta](classes/RecvDelta.md) -- [Red](classes/Red.md) -- [RedEncoder](classes/RedEncoder.md) -- [RedHandler](classes/RedHandler.md) -- [RedHeader](classes/RedHeader.md) -- [RtcpHeader](classes/RtcpHeader.md) -- [RtcpPacketConverter](classes/RtcpPacketConverter.md) -- [RtcpPayloadSpecificFeedback](classes/RtcpPayloadSpecificFeedback.md) -- [RtcpReceiverInfo](classes/RtcpReceiverInfo.md) -- [RtcpRrPacket](classes/RtcpRrPacket.md) -- [RtcpSenderInfo](classes/RtcpSenderInfo.md) -- [RtcpSourceDescriptionPacket](classes/RtcpSourceDescriptionPacket.md) -- [RtcpSrPacket](classes/RtcpSrPacket.md) -- [RtcpTransportLayerFeedback](classes/RtcpTransportLayerFeedback.md) -- [RtpBuilder](classes/RtpBuilder.md) -- [RtpHeader](classes/RtpHeader.md) -- [RtpPacket](classes/RtpPacket.md) -- [RunLengthChunk](classes/RunLengthChunk.md) -- [SourceDescriptionChunk](classes/SourceDescriptionChunk.md) -- [SourceDescriptionItem](classes/SourceDescriptionItem.md) -- [SrtcpSession](classes/SrtcpSession.md) -- [SrtpSession](classes/SrtpSession.md) -- [StatusVectorChunk](classes/StatusVectorChunk.md) -- [TransportWideCC](classes/TransportWideCC.md) -- [Vp8RtpPayload](classes/Vp8RtpPayload.md) -- [Vp9RtpPayload](classes/Vp9RtpPayload.md) -- [WeriftError](classes/WeriftError.md) - -### Type Aliases - -- [AudioLevelIndicationPayload](modules.md#audiolevelindicationpayload) -- [DepacketizerCodec](modules.md#depacketizercodec) -- [Extension](modules.md#extension) -- [InterfaceAddresses](modules.md#interfaceaddresses) -- [RequireAtLeastOne](modules.md#requireatleastone) -- [RtcpPacket](modules.md#rtcppacket) -- [TransportWideCCPayload](modules.md#transportwideccpayload) - -### Variables - -- [ExtensionProfiles](modules.md#extensionprofiles) -- [NalUnitType](modules.md#nalunittype) -- [RTCP\_HEADER\_SIZE](modules.md#rtcp_header_size) -- [RTP\_EXTENSION\_URI](modules.md#rtp_extension_uri) -- [depacketizerCodecs](modules.md#depacketizercodecs) -- [timer](modules.md#timer) - -### Functions - -- [Int](modules.md#int) -- [buffer2ArrayBuffer](modules.md#buffer2arraybuffer) -- [bufferArrayXor](modules.md#bufferarrayxor) -- [bufferReader](modules.md#bufferreader) -- [bufferWriter](modules.md#bufferwriter) -- [bufferWriterLE](modules.md#bufferwriterle) -- [bufferXor](modules.md#bufferxor) -- [createBufferWriter](modules.md#createbufferwriter) -- [dePacketizeRtpPackets](modules.md#depacketizertppackets) -- [deserializeAbsSendTime](modules.md#deserializeabssendtime) -- [deserializeAudioLevelIndication](modules.md#deserializeaudiolevelindication) -- [deserializeString](modules.md#deserializestring) -- [deserializeUint16BE](modules.md#deserializeuint16be) -- [dumpBuffer](modules.md#dumpbuffer) -- [enumerate](modules.md#enumerate) -- [findPort](modules.md#findport) -- [getBit](modules.md#getbit) -- [growBufferSize](modules.md#growbuffersize) -- [int](modules.md#int-1) -- [interfaceAddress](modules.md#interfaceaddress) -- [isMedia](modules.md#ismedia) -- [isRtcp](modules.md#isrtcp) -- [leb128decode](modules.md#leb128decode) -- [ntpTime2Sec](modules.md#ntptime2sec) -- [paddingBits](modules.md#paddingbits) -- [paddingByte](modules.md#paddingbyte) -- [random16](modules.md#random16) -- [random32](modules.md#random32) -- [randomPort](modules.md#randomport) -- [randomPorts](modules.md#randomports) -- [rtpHeaderExtensionsParser](modules.md#rtpheaderextensionsparser) -- [serializeAbsSendTime](modules.md#serializeabssendtime) -- [serializeAudioLevelIndication](modules.md#serializeaudiolevelindication) -- [serializeRepairedRtpStreamId](modules.md#serializerepairedrtpstreamid) -- [serializeSdesMid](modules.md#serializesdesmid) -- [serializeSdesRTPStreamID](modules.md#serializesdesrtpstreamid) -- [serializeTransportWideCC](modules.md#serializetransportwidecc) -- [uint16Add](modules.md#uint16add) -- [uint16Gt](modules.md#uint16gt) -- [uint16Gte](modules.md#uint16gte) -- [uint24](modules.md#uint24) -- [uint32Add](modules.md#uint32add) -- [uint32Gt](modules.md#uint32gt) -- [uint32Gte](modules.md#uint32gte) -- [uint8Add](modules.md#uint8add) -- [unwrapRtx](modules.md#unwraprtx) -- [wrapRtx](modules.md#wraprtx) - -## Type Aliases - -### AudioLevelIndicationPayload - -Ƭ **AudioLevelIndicationPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `level` | `number` | -| `v` | `boolean` | - -___ - -### DepacketizerCodec - -Ƭ **DepacketizerCodec**: typeof [`depacketizerCodecs`](modules.md#depacketizercodecs)[`number`] \| `Lowercase`\ - -___ - -### Extension - -Ƭ **Extension**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `number` | -| `payload` | `Buffer` | - -___ - -### InterfaceAddresses - -Ƭ **InterfaceAddresses**: \{ [K in SocketType]?: string } - -___ - -### RequireAtLeastOne - -Ƭ **RequireAtLeastOne**\<`T`\>: \{ [K in keyof T]-?: Required\\> & Partial\\>\> }[keyof `T`] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -___ - -### RtcpPacket - -Ƭ **RtcpPacket**: [`RtcpRrPacket`](classes/RtcpRrPacket.md) \| [`RtcpSrPacket`](classes/RtcpSrPacket.md) \| [`RtcpPayloadSpecificFeedback`](classes/RtcpPayloadSpecificFeedback.md) \| [`RtcpSourceDescriptionPacket`](classes/RtcpSourceDescriptionPacket.md) \| [`RtcpTransportLayerFeedback`](classes/RtcpTransportLayerFeedback.md) - -___ - -### TransportWideCCPayload - -Ƭ **TransportWideCCPayload**: `number` - -## Variables - -### ExtensionProfiles - -• `Const` **ExtensionProfiles**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `OneByte` | ``48862`` | -| `TwoByte` | ``4096`` | - -___ - -### NalUnitType - -• `Const` **NalUnitType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fu_a` | ``28`` | -| `fu_b` | ``29`` | -| `idrSlice` | ``5`` | -| `mtap16` | ``26`` | -| `mtap24` | ``27`` | -| `stap_a` | ``24`` | -| `stap_b` | ``25`` | - -___ - -### RTCP\_HEADER\_SIZE - -• `Const` **RTCP\_HEADER\_SIZE**: ``4`` - -___ - -### RTP\_EXTENSION\_URI - -• `Const` **RTP\_EXTENSION\_URI**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `absSendTime` | ``"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"`` | -| `audioLevelIndication` | ``"urn:ietf:params:rtp-hdrext:ssrc-audio-level"`` | -| `dependencyDescriptor` | ``"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"`` | -| `repairedRtpStreamId` | ``"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"`` | -| `sdesMid` | ``"urn:ietf:params:rtp-hdrext:sdes:mid"`` | -| `sdesRTPStreamID` | ``"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"`` | -| `transportWideCC` | ``"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"`` | - -___ - -### depacketizerCodecs - -• `Const` **depacketizerCodecs**: readonly [``"MPEG4/ISO/AVC"``, ``"VP8"``, ``"VP9"``, ``"OPUS"``, ``"AV1"``] - -___ - -### timer - -• `Const` **timer**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `setInterval` | (...`args`: [callback: Function, ms?: number]) => () => `void` | -| `setTimeout` | (...`args`: [callback: Function, ms?: number]) => () => `void` | - -## Functions - -### Int - -▸ **Int**(`v`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | `number` | - -#### Returns - -`number` - -___ - -### buffer2ArrayBuffer - -▸ **buffer2ArrayBuffer**(`buf`): `ArrayBuffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`ArrayBuffer` - -___ - -### bufferArrayXor - -▸ **bufferArrayXor**(`arr`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `arr` | `Buffer`[] | - -#### Returns - -`Buffer` - -___ - -### bufferReader - -▸ **bufferReader**(`buf`, `bytes`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `bytes` | `number`[] | - -#### Returns - -`any`[] - -___ - -### bufferWriter - -▸ **bufferWriter**(`bytes`, `values`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `values` | (`number` \| `bigint`)[] | - -#### Returns - -`Buffer` - -___ - -### bufferWriterLE - -▸ **bufferWriterLE**(`bytes`, `values`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `values` | (`number` \| `bigint`)[] | - -#### Returns - -`Buffer` - -___ - -### bufferXor - -▸ **bufferXor**(`a`, `b`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `Buffer` | -| `b` | `Buffer` | - -#### Returns - -`Buffer` - -___ - -### createBufferWriter - -▸ **createBufferWriter**(`bytes`, `singleBuffer?`): (`values`: (`number` \| `bigint`)[]) => `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `number`[] | -| `singleBuffer?` | `boolean` | - -#### Returns - -`fn` - -▸ (`values`): `Buffer` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `values` | (`number` \| `bigint`)[] | - -##### Returns - -`Buffer` - -___ - -### dePacketizeRtpPackets - -▸ **dePacketizeRtpPackets**(`codec`, `packets`, `frameFragmentBuffer?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `codec` | [`DepacketizerCodec`](modules.md#depacketizercodec) | -| `packets` | [`RtpPacket`](classes/RtpPacket.md)[] | -| `frameFragmentBuffer?` | `Buffer` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | -| `frameFragmentBuffer?` | `Buffer` | -| `isKeyframe` | `boolean` | -| `sequence` | `number` | -| `timestamp` | `number` | - -___ - -### deserializeAbsSendTime - -▸ **deserializeAbsSendTime**(`buf`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`any` - -___ - -### deserializeAudioLevelIndication - -▸ **deserializeAudioLevelIndication**(`buf`): [`AudioLevelIndicationPayload`](modules.md#audiolevelindicationpayload) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -[`AudioLevelIndicationPayload`](modules.md#audiolevelindicationpayload) - -___ - -### deserializeString - -▸ **deserializeString**(`buf`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`string` - -___ - -### deserializeUint16BE - -▸ **deserializeUint16BE**(`buf`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`number` - -___ - -### dumpBuffer - -▸ **dumpBuffer**(`data`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Buffer` | - -#### Returns - -`string` - -___ - -### enumerate - -▸ **enumerate**\<`T`\>(`arr`): [`number`, `T`][] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `arr` | `T`[] | - -#### Returns - -[`number`, `T`][] - -___ - -### findPort - -▸ **findPort**(`min`, `max`, `protocol?`, `interfaceAddresses?`): `Promise`\<`number`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `min` | `number` | `undefined` | -| `max` | `number` | `undefined` | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`\> - -___ - -### getBit - -▸ **getBit**(`bits`, `startIndex`, `length?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `bits` | `number` | `undefined` | -| `startIndex` | `number` | `undefined` | -| `length` | `number` | `1` | - -#### Returns - -`number` - -___ - -### growBufferSize - -▸ **growBufferSize**(`buf`, `size`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | -| `size` | `number` | - -#### Returns - -`Buffer` - -___ - -### int - -▸ **int**(`n`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -`number` - -___ - -### interfaceAddress - -▸ **interfaceAddress**(`type`, `interfaceAddresses`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `SocketType` | -| `interfaceAddresses` | `undefined` \| [`InterfaceAddresses`](modules.md#interfaceaddresses) | - -#### Returns - -`undefined` \| `string` - -___ - -### isMedia - -▸ **isMedia**(`buf`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`boolean` - -___ - -### isRtcp - -▸ **isRtcp**(`buf`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`boolean` - -___ - -### leb128decode - -▸ **leb128decode**(`buf`): `number`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`number`[] - -___ - -### ntpTime2Sec - -▸ **ntpTime2Sec**(`ntp`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ntp` | `bigint` | - -#### Returns - -`number` - -___ - -### paddingBits - -▸ **paddingBits**(`bits`, `expectLength`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bits` | `number` | -| `expectLength` | `number` | - -#### Returns - -`string` - -___ - -### paddingByte - -▸ **paddingByte**(`bits`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bits` | `number` | - -#### Returns - -`string` - -___ - -### random16 - -▸ **random16**(): `any` - -#### Returns - -`any` - -___ - -### random32 - -▸ **random32**(): `any` - -#### Returns - -`any` - -___ - -### randomPort - -▸ **randomPort**(`protocol?`, `interfaceAddresses?`): `Promise`\<`number`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`\> - -___ - -### randomPorts - -▸ **randomPorts**(`num`, `protocol?`, `interfaceAddresses?`): `Promise`\<`number`[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `num` | `number` | `undefined` | -| `protocol` | `SocketType` | `"udp4"` | -| `interfaceAddresses?` | [`InterfaceAddresses`](modules.md#interfaceaddresses) | `undefined` | - -#### Returns - -`Promise`\<`number`[]\> - -___ - -### rtpHeaderExtensionsParser - -▸ **rtpHeaderExtensionsParser**(`extensions`, `extIdUriMap`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extensions` | [`Extension`](modules.md#extension)[] | -| `extIdUriMap` | `Object` | - -#### Returns - -`Object` - -___ - -### serializeAbsSendTime - -▸ **serializeAbsSendTime**(`ntpTime`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ntpTime` | `bigint` | - -#### Returns - -`Buffer` - -___ - -### serializeAudioLevelIndication - -▸ **serializeAudioLevelIndication**(`level`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `level` | `number` | - -#### Returns - -`Buffer` - -___ - -### serializeRepairedRtpStreamId - -▸ **serializeRepairedRtpStreamId**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeSdesMid - -▸ **serializeSdesMid**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeSdesRTPStreamID - -▸ **serializeSdesRTPStreamID**(`id`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Buffer` - -___ - -### serializeTransportWideCC - -▸ **serializeTransportWideCC**(`transportSequenceNumber`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transportSequenceNumber` | `number` | - -#### Returns - -`Buffer` - -___ - -### uint16Add - -▸ **uint16Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### uint16Gt - -▸ **uint16Gt**(`a`, `b`): `boolean` - -Return a > b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint16Gte - -▸ **uint16Gte**(`a`, `b`): `boolean` - -Return a >= b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint24 - -▸ **uint24**(`v`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | `number` | - -#### Returns - -`number` - -___ - -### uint32Add - -▸ **uint32Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### uint32Gt - -▸ **uint32Gt**(`a`, `b`): `boolean` - -Return a > b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint32Gte - -▸ **uint32Gte**(`a`, `b`): `boolean` - -Return a >= b - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`boolean` - -___ - -### uint8Add - -▸ **uint8Add**(`a`, `b`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `number` | -| `b` | `number` | - -#### Returns - -`number` - -___ - -### unwrapRtx - -▸ **unwrapRtx**(`rtx`, `payloadType`, `ssrc`): [`RtpPacket`](classes/RtpPacket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `rtx` | [`RtpPacket`](classes/RtpPacket.md) | -| `payloadType` | `number` | -| `ssrc` | `number` | - -#### Returns - -[`RtpPacket`](classes/RtpPacket.md) - -___ - -### wrapRtx - -▸ **wrapRtx**(`packet`, `payloadType`, `sequenceNumber`, `ssrc`): [`RtpPacket`](classes/RtpPacket.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `packet` | [`RtpPacket`](classes/RtpPacket.md) | -| `payloadType` | `number` | -| `sequenceNumber` | `number` | -| `ssrc` | `number` | - -#### Returns - -[`RtpPacket`](classes/RtpPacket.md) diff --git a/packages/rtp/doc/type-aliases/AudioLevelIndicationPayload.md b/packages/rtp/doc/type-aliases/AudioLevelIndicationPayload.md new file mode 100644 index 000000000..43569db55 --- /dev/null +++ b/packages/rtp/doc/type-aliases/AudioLevelIndicationPayload.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / AudioLevelIndicationPayload + +# Type Alias: AudioLevelIndicationPayload + +> **AudioLevelIndicationPayload**: `object` + +## Type declaration + +### level + +> **level**: `number` + +### v + +> **v**: `boolean` diff --git a/packages/rtp/doc/type-aliases/DepacketizerCodec.md b/packages/rtp/doc/type-aliases/DepacketizerCodec.md new file mode 100644 index 000000000..d619fef9d --- /dev/null +++ b/packages/rtp/doc/type-aliases/DepacketizerCodec.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / DepacketizerCodec + +# Type Alias: DepacketizerCodec + +> **DepacketizerCodec**: *typeof* [`depacketizerCodecs`](../variables/depacketizerCodecs.md)\[`number`\] \| `Lowercase`\<*typeof* [`depacketizerCodecs`](../variables/depacketizerCodecs.md)\[`number`\]\> diff --git a/packages/rtp/doc/type-aliases/Extension.md b/packages/rtp/doc/type-aliases/Extension.md new file mode 100644 index 000000000..adb3baf90 --- /dev/null +++ b/packages/rtp/doc/type-aliases/Extension.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / Extension + +# Type Alias: Extension + +> **Extension**: `object` + +## Type declaration + +### id + +> **id**: `number` + +### payload + +> **payload**: `Buffer` diff --git a/packages/rtp/doc/type-aliases/InterfaceAddresses.md b/packages/rtp/doc/type-aliases/InterfaceAddresses.md new file mode 100644 index 000000000..815dbfafa --- /dev/null +++ b/packages/rtp/doc/type-aliases/InterfaceAddresses.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / InterfaceAddresses + +# Type Alias: InterfaceAddresses + +> **InterfaceAddresses**: `{ [K in SocketType]?: string }` diff --git a/packages/rtp/doc/type-aliases/RequireAtLeastOne.md b/packages/rtp/doc/type-aliases/RequireAtLeastOne.md new file mode 100644 index 000000000..13d583933 --- /dev/null +++ b/packages/rtp/doc/type-aliases/RequireAtLeastOne.md @@ -0,0 +1,13 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / RequireAtLeastOne + +# Type Alias: RequireAtLeastOne\ + +> **RequireAtLeastOne**\<`T`\>: `{ [K in keyof T]-?: Required> & Partial>> }`\[keyof `T`\] + +## Type Parameters + +• **T** diff --git a/packages/rtp/doc/type-aliases/RtcpPacket.md b/packages/rtp/doc/type-aliases/RtcpPacket.md new file mode 100644 index 000000000..d0603140e --- /dev/null +++ b/packages/rtp/doc/type-aliases/RtcpPacket.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / RtcpPacket + +# Type Alias: RtcpPacket + +> **RtcpPacket**: [`RtcpRrPacket`](../classes/RtcpRrPacket.md) \| [`RtcpSrPacket`](../classes/RtcpSrPacket.md) \| [`RtcpPayloadSpecificFeedback`](../classes/RtcpPayloadSpecificFeedback.md) \| [`RtcpSourceDescriptionPacket`](../classes/RtcpSourceDescriptionPacket.md) \| [`RtcpTransportLayerFeedback`](../classes/RtcpTransportLayerFeedback.md) diff --git a/packages/rtp/doc/type-aliases/TransportWideCCPayload.md b/packages/rtp/doc/type-aliases/TransportWideCCPayload.md new file mode 100644 index 000000000..8e6dc4493 --- /dev/null +++ b/packages/rtp/doc/type-aliases/TransportWideCCPayload.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / TransportWideCCPayload + +# Type Alias: TransportWideCCPayload + +> **TransportWideCCPayload**: `number` diff --git a/packages/rtp/doc/variables/ExtensionProfiles.md b/packages/rtp/doc/variables/ExtensionProfiles.md new file mode 100644 index 000000000..b5658d6a0 --- /dev/null +++ b/packages/rtp/doc/variables/ExtensionProfiles.md @@ -0,0 +1,19 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / ExtensionProfiles + +# Variable: ExtensionProfiles + +> `const` **ExtensionProfiles**: `object` + +## Type declaration + +### OneByte + +> `readonly` **OneByte**: `48862` = `0xbede` + +### TwoByte + +> `readonly` **TwoByte**: `4096` = `0x1000` diff --git a/packages/rtp/doc/variables/NalUnitType.md b/packages/rtp/doc/variables/NalUnitType.md new file mode 100644 index 000000000..5b9850064 --- /dev/null +++ b/packages/rtp/doc/variables/NalUnitType.md @@ -0,0 +1,39 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / NalUnitType + +# Variable: NalUnitType + +> `const` **NalUnitType**: `object` + +## Type declaration + +### fu\_a + +> `readonly` **fu\_a**: `28` = `28` + +### fu\_b + +> `readonly` **fu\_b**: `29` = `29` + +### idrSlice + +> `readonly` **idrSlice**: `5` = `5` + +### mtap16 + +> `readonly` **mtap16**: `26` = `26` + +### mtap24 + +> `readonly` **mtap24**: `27` = `27` + +### stap\_a + +> `readonly` **stap\_a**: `24` = `24` + +### stap\_b + +> `readonly` **stap\_b**: `25` = `25` diff --git a/packages/rtp/doc/variables/RTCP_HEADER_SIZE.md b/packages/rtp/doc/variables/RTCP_HEADER_SIZE.md new file mode 100644 index 000000000..933f7bb9e --- /dev/null +++ b/packages/rtp/doc/variables/RTCP_HEADER_SIZE.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / RTCP\_HEADER\_SIZE + +# Variable: RTCP\_HEADER\_SIZE + +> `const` **RTCP\_HEADER\_SIZE**: `4` = `4` diff --git a/packages/rtp/doc/variables/RTP_EXTENSION_URI.md b/packages/rtp/doc/variables/RTP_EXTENSION_URI.md new file mode 100644 index 000000000..4e138fe94 --- /dev/null +++ b/packages/rtp/doc/variables/RTP_EXTENSION_URI.md @@ -0,0 +1,39 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / RTP\_EXTENSION\_URI + +# Variable: RTP\_EXTENSION\_URI + +> `const` **RTP\_EXTENSION\_URI**: `object` + +## Type declaration + +### absSendTime + +> `readonly` **absSendTime**: `"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"` = `"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"` + +### audioLevelIndication + +> `readonly` **audioLevelIndication**: `"urn:ietf:params:rtp-hdrext:ssrc-audio-level"` = `"urn:ietf:params:rtp-hdrext:ssrc-audio-level"` + +### dependencyDescriptor + +> `readonly` **dependencyDescriptor**: `"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"` = `"https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension"` + +### repairedRtpStreamId + +> `readonly` **repairedRtpStreamId**: `"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"` = `"urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id"` + +### sdesMid + +> `readonly` **sdesMid**: `"urn:ietf:params:rtp-hdrext:sdes:mid"` = `"urn:ietf:params:rtp-hdrext:sdes:mid"` + +### sdesRTPStreamID + +> `readonly` **sdesRTPStreamID**: `"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"` = `"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"` + +### transportWideCC + +> `readonly` **transportWideCC**: `"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"` = `"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"` diff --git a/packages/rtp/doc/variables/depacketizerCodecs.md b/packages/rtp/doc/variables/depacketizerCodecs.md new file mode 100644 index 000000000..838b523ea --- /dev/null +++ b/packages/rtp/doc/variables/depacketizerCodecs.md @@ -0,0 +1,9 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / depacketizerCodecs + +# Variable: depacketizerCodecs + +> `const` **depacketizerCodecs**: readonly [`"MPEG4/ISO/AVC"`, `"VP8"`, `"VP9"`, `"OPUS"`, `"AV1"`] diff --git a/packages/rtp/doc/variables/timer.md b/packages/rtp/doc/variables/timer.md new file mode 100644 index 000000000..e05bf512d --- /dev/null +++ b/packages/rtp/doc/variables/timer.md @@ -0,0 +1,43 @@ +[**werift-rtp**](../README.md) • **Docs** + +*** + +[werift-rtp](../globals.md) / timer + +# Variable: timer + +> `const` **timer**: `object` + +## Type declaration + +### setInterval() + +> **setInterval**: (...`args`) => () => `void` + +#### Parameters + +• ...**args**: [(`args`) => `void`, `number`] + +#### Returns + +`Function` + +##### Returns + +`void` + +### setTimeout() + +> **setTimeout**: (...`args`) => () => `void` + +#### Parameters + +• ...**args**: [(`args`) => `void`, `number`] + +#### Returns + +`Function` + +##### Returns + +`void`