Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
/ aioice Public

asyncio-based Interactive Connectivity Establishment (RFC 5245)

License

Notifications You must be signed in to change notification settings

aiortc/aioice

Repository files navigation

aioice

What is aioice?

aioice is a library for Interactive Connectivity Establishment (RFC 5245) in Python. It is built on top of asyncio, Python's standard asynchronous I/O framework.

Interactive Connectivity Establishment (ICE) is useful for applications that establish peer-to-peer UDP data streams, as it facilitates NAT traversal. Typical usecases include SIP and WebRTC.

To learn more about aioice please read the documentation.

Example

import asyncio
import aioice

async def connect_using_ice():
connection = aioice.Connection(ice_controlling=True)

# gather local candidates
await connection.gather_candidates()

# send your information to the remote party using your signaling method
send_local_info(
connection.local_candidates,
connection.local_username,
connection.local_password)

# receive remote information using your signaling method
remote_candidates, remote_username, remote_password = get_remote_info()

# perform ICE handshake
for candidate in remote_candidates:
await connection.add_remote_candidate(candidate)
await connection.add_remote_candidate(None)
connection.remote_username = remote_username
connection.remote_password = remote_password
await connection.connect()

# send and receive data
await connection.sendto(b'1234', 1)
data, component = await connection.recvfrom()

# close connection
await connection.close()

asyncio.run(connect_using_ice())

License

aioice is released under the BSD license.

About

asyncio-based Interactive Connectivity Establishment (RFC 5245)

Topics

Resources

Readme

License

BSD-3-Clause license

Stars

Watchers

Forks

Packages

Contributors

Languages