sora-sdk 2025.2.0.dev1__cp313-cp313-win_amd64.whl → 2025.2.0.dev2__cp313-cp313-win_amd64.whl

{sora_sdk-2025.2.0.dev1.data → sora_sdk-2025.2.0.dev2.data}/purelib/sora_sdk/sora_sdk_ext.pyi

@@ -5,44 +5,107 @@ from typing import Annotated, overload
 from numpy.typing import ArrayLike
 
 
-class Sora:
-    def __init__(self, openh264: str | None = None, video_codec_preference: SoraVideoCodecPreference | None = None) -> None: ...
+class SoraSignalingErrorCode(enum.IntEnum):
+    CLOSE_SUCCEEDED = 0
 
-    def create_connection(self, signaling_urls: list[str], role: str, channel_id: str, client_id: Optional[str] = None, bundle_id: Optional[str] = None, metadata: Optional[dict] = None, signaling_notify_metadata: Optional[dict] = None, audio_source: Optional[SoraTrackInterface] = None, video_source: Optional[SoraTrackInterface] = None, audio_frame_transformer: Optional[SoraAudioFrameTransformer] = None, video_frame_transformer: Optional[SoraVideoFrameTransformer] = None, audio: Optional[bool] = None, video: Optional[bool] = None, audio_codec_type: Optional[str] = None, video_codec_type: Optional[str] = None, video_bit_rate: Optional[int] = None, audio_bit_rate: Optional[int] = None, video_vp9_params: Optional[dict] = None, video_av1_params: Optional[dict] = None, video_h264_params: Optional[dict] = None, audio_opus_params: Optional[dict] = None, simulcast: Optional[bool] = None, spotlight: Optional[bool] = None, spotlight_number: Optional[int] = None, simulcast_rid: Optional[str] = None, spotlight_focus_rid: Optional[str] = None, spotlight_unfocus_rid: Optional[str] = None, forwarding_filter: Optional[dict] = None, forwarding_filters: Optional[list[dict]] = None, data_channels: Optional[list[dict]] = None, data_channel_signaling: Optional[bool] = None, ignore_disconnect_websocket: Optional[bool] = None, data_channel_signaling_timeout: Optional[int] = None, disconnect_wait_timeout: Optional[int] = None, websocket_close_timeout: Optional[int] = None, websocket_connection_timeout: Optional[int] = None, audio_streaming_language_code: Optional[str] = None, insecure: Optional[bool] = None, client_cert: Optional[bytes] = None, client_key: Optional[bytes] = None, ca_cert: Optional[bytes] = None, proxy_url: Optional[str] = None, proxy_username: Optional[str] = None, proxy_password: Optional[str] = None, proxy_agent: Optional[str] = None, degradation_preference: Optional[SoraDegradationPreference] = None) -> SoraConnection: ...
+    CLOSE_FAILED = 1
 
-    def create_audio_source(self, channels: int, sample_rate: int) -> SoraAudioSource: ...
+    INTERNAL_ERROR = 2
 
-    def create_video_source(self) -> SoraVideoSource: ...
+    INVALID_PARAMETER = 3
 
-class SoraAudioFrame:
-    def __getstate__(self) -> tuple[list[int], int, int, int, int | None]: ...
+    WEBSOCKET_HANDSHAKE_FAILED = 4
 
-    def __setstate__(self, arg: tuple[Sequence[int], int, int, int, int | None], /) -> None: ...
+    WEBSOCKET_ONCLOSE = 5
+
+    WEBSOCKET_ONERROR = 6
+
+    PEER_CONNECTION_STATE_FAILED = 7
+
+    ICE_FAILED = 8
+
+class SoraSignalingType(enum.IntEnum):
+    WEBSOCKET = 0
+
+    DATACHANNEL = 1
+
+class SoraDegradationPreference(enum.IntEnum):
+    DISABLED = 0
+
+    BALANCED = 3
+
+    MAINTAIN_FRAMERATE = 1
+
+    MAINTAIN_RESOLUTION = 2
+
+class SoraSignalingDirection(enum.IntEnum):
+    SENT = 0
+
+    RECEIVED = 1
+
+class SoraTrackState(enum.IntEnum):
+    LIVE = 0
+
+    ENDED = 1
+
+class SoraLoggingSeverity(enum.IntEnum):
+    VERBOSE = 0
+
+    INFO = 1
+
+    WARNING = 2
+
+    ERROR = 3
+
+    NONE = 4
+
+def enable_libwebrtc_log(arg: SoraLoggingSeverity, /) -> None: ...
+
+def rtc_log(arg0: SoraLoggingSeverity, arg1: str, /) -> None: ...
 
+class SoraTrackInterface:
     @property
-    def samples_per_channel(self) -> int: ...
+    def kind(self) -> str: ...
 
     @property
-    def num_channels(self) -> int: ...
+    def id(self) -> str: ...
 
     @property
-    def sample_rate_hz(self) -> int: ...
+    def enabled(self) -> bool: ...
 
     @property
-    def absolute_capture_timestamp_ms(self) -> int | None: ...
+    def state(self) -> SoraTrackState: ...
 
-    def data(self) -> Annotated[ArrayLike, dict(dtype='int16', shape=(None, None))]: ...
+    def set_enabled(self, enable: bool) -> bool: ...
 
-class SoraAudioFrameTransformer(SoraFrameTransformer):
-    def __init__(self) -> None: ...
+class SoraMediaTrack(SoraTrackInterface):
+    @property
+    def stream_id(self) -> str: ...
 
-    def __del__(self) -> None: ...
+    def set_frame_transformer(self, arg: SoraFrameTransformer, /) -> None: ...
 
-    @property
-    def on_transform(self) -> Callable[[SoraTransformableAudioFrame], None]: ...
+class SoraAudioSource(SoraTrackInterface):
+    @overload
+    def on_data(self, data: int, samples_per_channel: int, timestamp: float) -> None: ...
 
-    @on_transform.setter
-    def on_transform(self, arg: Callable[[SoraTransformableAudioFrame], None], /) -> None: ...
+    @overload
+    def on_data(self, data: int, samples_per_channel: int) -> None: ...
+
+    @overload
+    def on_data(self, ndarray: Annotated[ArrayLike, dict(dtype='int16', shape=(None, None), order='C', device='cpu')], timestamp: float) -> None: ...
+
+    @overload
+    def on_data(self, ndarray: Annotated[ArrayLike, dict(dtype='int16', shape=(None, None), order='C', device='cpu')]) -> None: ...
+
+class SoraVideoSource(SoraTrackInterface):
+    @overload
+    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')]) -> None: ...
+
+    @overload
+    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')], timestamp: float) -> None: ...
+
+    @overload
+    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')], timestamp_us: int) -> None: ...
 
 class SoraAudioSinkImpl:
     def __init__(self, track: SoraTrackInterface, output_frequency: int = -1, output_channels: int = 0) -> None: ...
@@ -63,18 +126,24 @@ class SoraAudioSinkImpl:
     @on_format.setter
     def on_format(self, arg: Callable[[int, int], None], /) -> None: ...
 
-class SoraAudioSource(SoraTrackInterface):
-    @overload
-    def on_data(self, data: int, samples_per_channel: int, timestamp: float) -> None: ...
+class SoraAudioFrame:
+    def __getstate__(self) -> tuple[list[int], int, int, int, int | None]: ...
 
-    @overload
-    def on_data(self, data: int, samples_per_channel: int) -> None: ...
+    def __setstate__(self, arg: tuple[Sequence[int], int, int, int, int | None], /) -> None: ...
 
-    @overload
-    def on_data(self, ndarray: Annotated[ArrayLike, dict(dtype='int16', shape=(None, None), order='C', device='cpu')], timestamp: float) -> None: ...
+    @property
+    def samples_per_channel(self) -> int: ...
 
-    @overload
-    def on_data(self, ndarray: Annotated[ArrayLike, dict(dtype='int16', shape=(None, None), order='C', device='cpu')]) -> None: ...
+    @property
+    def num_channels(self) -> int: ...
+
+    @property
+    def sample_rate_hz(self) -> int: ...
+
+    @property
+    def absolute_capture_timestamp_ms(self) -> int | None: ...
+
+    def data(self) -> Annotated[ArrayLike, dict(dtype='int16', shape=(None, None))]: ...
 
 class SoraAudioStreamSinkImpl:
     def __init__(self, track: SoraTrackInterface, output_frequency: int = -1, output_channels: int = 0) -> None: ...
@@ -87,6 +156,25 @@ class SoraAudioStreamSinkImpl:
     @on_frame.setter
     def on_frame(self, arg: Callable[[SoraAudioFrame], None], /) -> None: ...
 
+class SoraVAD:
+    def __init__(self) -> None: ...
+
+    def analyze(self, frame: SoraAudioFrame) -> float: ...
+
+class SoraVideoFrame:
+    def data(self) -> Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3))]: ...
+
+class SoraVideoSinkImpl:
+    def __init__(self, arg: SoraTrackInterface, /) -> None: ...
+
+    def __del__(self) -> None: ...
+
+    @property
+    def on_frame(self) -> Callable[[SoraVideoFrame], None]: ...
+
+    @on_frame.setter
+    def on_frame(self, arg: Callable[[SoraVideoFrame], None], /) -> None: ...
+
 class SoraConnection:
     def connect(self) -> None: ...
 
@@ -156,85 +244,42 @@ class SoraConnection:
     @on_data_channel.setter
     def on_data_channel(self, arg: Callable[[str], None], /) -> None: ...
 
-class SoraDegradationPreference(enum.IntEnum):
-    DISABLED = 0
-
-    BALANCED = 3
-
-    MAINTAIN_FRAMERATE = 1
-
-    MAINTAIN_RESOLUTION = 2
-
-class SoraFrameTransformer:
-    def enqueue(self, arg: SoraTransformableFrame, /) -> None: ...
-
-    def start_short_circuiting(self) -> None: ...
-
-class SoraLoggingSeverity(enum.IntEnum):
-    VERBOSE = 0
+class SoraTransformableFrameDirection(enum.IntEnum):
+    UNKNOWN = 0
 
-    INFO = 1
+    RECEIVER = 1
 
-    WARNING = 2
+    SENDER = 2
 
-    ERROR = 3
+class SoraTransformableFrame:
+    def get_data(self) -> Annotated[ArrayLike, dict(dtype='uint8', shape=(None), writable=False)]: ...
 
-    NONE = 4
+    def set_data(self, arg: Annotated[ArrayLike, dict(dtype='uint8', shape=(None), order='C', device='cpu', writable=False)], /) -> None: ...
 
-class SoraMediaTrack(SoraTrackInterface):
     @property
-    def stream_id(self) -> str: ...
-
-    def set_frame_transformer(self, arg: SoraFrameTransformer, /) -> None: ...
-
-class SoraSignalingDirection(enum.IntEnum):
-    SENT = 0
-
-    RECEIVED = 1
-
-class SoraSignalingErrorCode(enum.IntEnum):
-    CLOSE_SUCCEEDED = 0
-
-    CLOSE_FAILED = 1
-
-    INTERNAL_ERROR = 2
-
-    INVALID_PARAMETER = 3
-
-    WEBSOCKET_HANDSHAKE_FAILED = 4
-
-    WEBSOCKET_ONCLOSE = 5
-
-    WEBSOCKET_ONERROR = 6
-
-    PEER_CONNECTION_STATE_FAILED = 7
-
-    ICE_FAILED = 8
-
-class SoraSignalingType(enum.IntEnum):
-    WEBSOCKET = 0
-
-    DATACHANNEL = 1
+    def payload_type(self) -> int: ...
 
-class SoraTrackInterface:
     @property
-    def kind(self) -> str: ...
+    def ssrc(self) -> int: ...
 
     @property
-    def id(self) -> str: ...
+    def rtp_timestamp(self) -> int: ...
+
+    @rtp_timestamp.setter
+    def rtp_timestamp(self, arg: int, /) -> None: ...
 
     @property
-    def enabled(self) -> bool: ...
+    def direction(self) -> SoraTransformableFrameDirection: ...
 
     @property
-    def state(self) -> SoraTrackState: ...
+    def mine_type(self) -> str: ...
 
-    def set_enabled(self, enable: bool) -> bool: ...
+class SoraTransformableAudioFrameType(enum.IntEnum):
+    EMPTY = 0
 
-class SoraTrackState(enum.IntEnum):
-    LIVE = 0
+    SPEECH = 1
 
-    ENDED = 1
+    CN = 2
 
 class SoraTransformableAudioFrame(SoraTransformableFrame):
     @property
@@ -255,72 +300,79 @@ class SoraTransformableAudioFrame(SoraTransformableFrame):
     @property
     def receive_time(self) -> int | None: ...
 
-class SoraTransformableAudioFrameType(enum.IntEnum):
-    EMPTY = 0
+class SoraTransformableVideoFrame(SoraTransformableFrame):
+    @property
+    def is_key_frame(self) -> bool: ...
 
-    SPEECH = 1
+    @property
+    def frame_id(self) -> int | None: ...
 
-    CN = 2
+    @property
+    def frame_dependencies(self) -> Annotated[ArrayLike, dict(dtype='int64', shape=(None), writable=False)]: ...
 
-class SoraTransformableFrame:
-    def get_data(self) -> Annotated[ArrayLike, dict(dtype='uint8', shape=(None), writable=False)]: ...
+    @property
+    def width(self) -> int: ...
 
-    def set_data(self, arg: Annotated[ArrayLike, dict(dtype='uint8', shape=(None), order='C', device='cpu', writable=False)], /) -> None: ...
+    @property
+    def height(self) -> int: ...
 
     @property
-    def payload_type(self) -> int: ...
+    def spatial_index(self) -> int: ...
 
     @property
-    def ssrc(self) -> int: ...
+    def temporal_index(self) -> int: ...
 
     @property
-    def rtp_timestamp(self) -> int: ...
+    def contributing_sources(self) -> Annotated[ArrayLike, dict(dtype='uint32', shape=(None), writable=False)]: ...
 
-    @rtp_timestamp.setter
-    def rtp_timestamp(self, arg: int, /) -> None: ...
+class SoraFrameTransformer:
+    def enqueue(self, arg: SoraTransformableFrame, /) -> None: ...
 
-    @property
-    def direction(self) -> SoraTransformableFrameDirection: ...
+    def start_short_circuiting(self) -> None: ...
+
+class SoraAudioFrameTransformer(SoraFrameTransformer):
+    def __init__(self) -> None: ...
+
+    def __del__(self) -> None: ...
 
     @property
-    def mine_type(self) -> str: ...
+    def on_transform(self) -> Callable[[SoraTransformableAudioFrame], None]: ...
 
-class SoraTransformableFrameDirection(enum.IntEnum):
-    UNKNOWN = 0
+    @on_transform.setter
+    def on_transform(self, arg: Callable[[SoraTransformableAudioFrame], None], /) -> None: ...
 
-    RECEIVER = 1
+class SoraVideoFrameTransformer(SoraFrameTransformer):
+    def __init__(self) -> None: ...
 
-    SENDER = 2
+    def __del__(self) -> None: ...
 
-class SoraTransformableVideoFrame(SoraTransformableFrame):
     @property
-    def is_key_frame(self) -> bool: ...
+    def on_transform(self) -> Callable[[SoraTransformableVideoFrame], None]: ...
 
-    @property
-    def frame_id(self) -> int | None: ...
+    @on_transform.setter
+    def on_transform(self, arg: Callable[[SoraTransformableVideoFrame], None], /) -> None: ...
 
-    @property
-    def frame_dependencies(self) -> Annotated[ArrayLike, dict(dtype='int64', shape=(None), writable=False)]: ...
+class SoraVideoCodecImplementation(enum.IntEnum):
+    INTERNAL = 0
 
-    @property
-    def width(self) -> int: ...
+    CISCO_OPENH264 = 1
 
-    @property
-    def height(self) -> int: ...
+    INTEL_VPL = 2
 
-    @property
-    def spatial_index(self) -> int: ...
+    NVIDIA_VIDEO_CODEC_SDK = 3
 
-    @property
-    def temporal_index(self) -> int: ...
+    AMD_AMF = 4
 
-    @property
-    def contributing_sources(self) -> Annotated[ArrayLike, dict(dtype='uint32', shape=(None), writable=False)]: ...
+class SoraVideoCodecType(enum.IntEnum):
+    VP8 = 1
 
-class SoraVAD:
-    def __init__(self) -> None: ...
+    VP9 = 2
 
-    def analyze(self, frame: SoraAudioFrame) -> float: ...
+    H264 = 4
+
+    H265 = 5
+
+    AV1 = 3
 
 class SoraVideoCodecCapability:
     @property
@@ -373,16 +425,7 @@ class SoraVideoCodecCapability:
         @property
         def parameters(self) -> SoraVideoCodecCapability.Parameters: ...
 
-class SoraVideoCodecImplementation(enum.IntEnum):
-    INTERNAL = 0
-
-    CISCO_OPENH264 = 1
-
-    INTEL_VPL = 2
-
-    NVIDIA_VIDEO_CODEC_SDK = 3
-
-    AMD_AMF = 4
+def get_video_codec_capability(openh264: str | None = None) -> SoraVideoCodecCapability: ...
 
 class SoraVideoCodecPreference:
     def __init__(self, codecs: Sequence[SoraVideoCodecPreference.Codec] = []) -> None: ...
@@ -437,56 +480,13 @@ class SoraVideoCodecPreference:
         @parameters.setter
         def parameters(self, arg: SoraVideoCodecPreference.Parameters, /) -> None: ...
 
-class SoraVideoCodecType(enum.IntEnum):
-    VP8 = 1
-
-    VP9 = 2
-
-    H264 = 4
-
-    H265 = 5
-
-    AV1 = 3
-
-class SoraVideoFrame:
-    def data(self) -> Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3))]: ...
-
-class SoraVideoFrameTransformer(SoraFrameTransformer):
-    def __init__(self) -> None: ...
-
-    def __del__(self) -> None: ...
-
-    @property
-    def on_transform(self) -> Callable[[SoraTransformableVideoFrame], None]: ...
-
-    @on_transform.setter
-    def on_transform(self, arg: Callable[[SoraTransformableVideoFrame], None], /) -> None: ...
-
-class SoraVideoSinkImpl:
-    def __init__(self, arg: SoraTrackInterface, /) -> None: ...
-
-    def __del__(self) -> None: ...
-
-    @property
-    def on_frame(self) -> Callable[[SoraVideoFrame], None]: ...
-
-    @on_frame.setter
-    def on_frame(self, arg: Callable[[SoraVideoFrame], None], /) -> None: ...
-
-class SoraVideoSource(SoraTrackInterface):
-    @overload
-    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')]) -> None: ...
-
-    @overload
-    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')], timestamp: float) -> None: ...
-
-    @overload
-    def on_captured(self, ndarray: Annotated[ArrayLike, dict(dtype='uint8', shape=(None, None, 3), order='C', device='cpu')], timestamp_us: int) -> None: ...
-
 def create_video_codec_preference_from_implementation(arg0: SoraVideoCodecCapability, arg1: SoraVideoCodecImplementation, /) -> SoraVideoCodecPreference: ...
 
-def enable_libwebrtc_log(arg: SoraLoggingSeverity, /) -> None: ...
+class Sora:
+    def __init__(self, openh264: str | None = None, video_codec_preference: SoraVideoCodecPreference | None = None) -> None: ...
 
-def get_video_codec_capability(openh264: str | None = None) -> SoraVideoCodecCapability: ...
+    def create_connection(self, signaling_urls: list[str], role: str, channel_id: str, client_id: Optional[str] = None, bundle_id: Optional[str] = None, metadata: Optional[dict] = None, signaling_notify_metadata: Optional[dict] = None, audio_source: Optional[SoraTrackInterface] = None, video_source: Optional[SoraTrackInterface] = None, audio_frame_transformer: Optional[SoraAudioFrameTransformer] = None, video_frame_transformer: Optional[SoraVideoFrameTransformer] = None, audio: Optional[bool] = None, video: Optional[bool] = None, audio_codec_type: Optional[str] = None, video_codec_type: Optional[str] = None, video_bit_rate: Optional[int] = None, audio_bit_rate: Optional[int] = None, video_vp9_params: Optional[dict] = None, video_av1_params: Optional[dict] = None, video_h264_params: Optional[dict] = None, audio_opus_params: Optional[dict] = None, simulcast: Optional[bool] = None, spotlight: Optional[bool] = None, spotlight_number: Optional[int] = None, simulcast_rid: Optional[str] = None, spotlight_focus_rid: Optional[str] = None, spotlight_unfocus_rid: Optional[str] = None, forwarding_filter: Optional[dict] = None, forwarding_filters: Optional[list[dict]] = None, data_channels: Optional[list[dict]] = None, data_channel_signaling: Optional[bool] = None, ignore_disconnect_websocket: Optional[bool] = None, data_channel_signaling_timeout: Optional[int] = None, disconnect_wait_timeout: Optional[int] = None, websocket_close_timeout: Optional[int] = None, websocket_connection_timeout: Optional[int] = None, audio_streaming_language_code: Optional[str] = None, insecure: Optional[bool] = None, client_cert: Optional[bytes] = None, client_key: Optional[bytes] = None, ca_cert: Optional[bytes] = None, proxy_url: Optional[str] = None, proxy_username: Optional[str] = None, proxy_password: Optional[str] = None, proxy_agent: Optional[str] = None, degradation_preference: Optional[SoraDegradationPreference] = None) -> SoraConnection: ...
 
-def rtc_log(arg0: SoraLoggingSeverity, arg1: str, /) -> None: ...
+    def create_audio_source(self, channels: int, sample_rate: int) -> SoraAudioSource: ...
+
+    def create_video_source(self) -> SoraVideoSource: ...