API docs¶

Note that ipywebrtc.webrtc is imported in the ipywebrtc namespace, to you can access ipywebrtc.CameraStream instead of ipywebrtc.webrtc.CameraStream.

ipywebrtc¶

ipywebrtc.chat(room=None, stream=None, **kwargs)[source]¶

ipywebrtc.webrtc¶

class ipywebrtc.webrtc.MediaStream(**kwargs)[source]¶

Bases: ipywidgets.widgets.domwidget.DOMWidget, ipywebrtc.webrtc.HasStream

Represents a media source.

class ipywebrtc.webrtc.VideoStream(**kwargs)[source]¶

Bases: ipywebrtc.webrtc.MediaStream

Represents a media source by a video.

data¶: A trait for byte strings.

filename¶: A trait for unicode strings.

loop¶: A boolean (True, False) trait.

play¶: A boolean (True, False) trait.

url¶: A trait for unicode strings.

class ipywebrtc.webrtc.CameraStream(**kwargs)[source]¶

Bases: ipywebrtc.webrtc.MediaStream

Represents a media source by a camera/webcam.

audio¶: A boolean (True, False) trait.

close()[source]¶

Close method.

Closes the underlying comm. When the comm is closed, all of the widget views are automatically removed from the front-end.

video¶: A boolean (True, False) trait.

class ipywebrtc.webrtc.MediaRecorder(**kwargs)[source]¶

Bases: ipywidgets.widgets.widget.Widget

data¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

filename¶: A trait for unicode strings.

mime_type¶: A trait for unicode strings.

record¶: A boolean (True, False) trait.

stream¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

class ipywebrtc.webrtc.WebRTCPeer(**kwargs)[source]¶

Bases: ipywebrtc.webrtc.MediaStream

close()[source]¶

Close method.

Closes the underlying comm. When the comm is closed, all of the widget views are automatically removed from the front-end.

connect()[source]¶

connected¶: A boolean (True, False) trait.

failed¶: A boolean (True, False) trait.

id_local¶: A trait for unicode strings.

id_remote¶: A trait for unicode strings.

stream_local¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

stream_remote¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

class ipywebrtc.webrtc.WebRTCRoom(**kwargs)[source]¶

Bases: ipywidgets.widgets.domwidget.DOMWidget

close()[source]¶

Close method.

Closes the underlying comm. When the comm is closed, all of the widget views are automatically removed from the front-end.

id¶: A trait for unicode strings.

nickname¶: A trait for unicode strings.

peers¶: An instance of a Python list.

room¶: A trait for unicode strings.

stream¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

streams¶: An instance of a Python list.

class ipywebrtc.webrtc.WebRTCRoomLocal(**kwargs)[source]¶: Bases: ipywebrtc.webrtc.WebRTCRoom

class ipywebrtc.webrtc.WebRTCRoomMqtt(**kwargs)[source]¶

Bases: ipywebrtc.webrtc.WebRTCRoom

server¶: A trait for unicode strings.