Add video API snippets

.env.dist

@@ -90,6 +90,15 @@ VERIFY_PAYEE_NAME='VERIFY_PAYEE_NAME'
 VERIFY_AMOUNT='VERIFY_AMOUNT'
 VERIFY_WORKFLOW_ID='VERIFY_WORKFLOW_ID'
 
+# Video
+VIDEO_SESSION_ID='VIDEO_SESSION_ID'
+VIDEO_TOKEN='VIDEO_TOKEN'
+VIDEO_STREAM_ID='VIDEO_STREAM_ID'
+VIDEO_ARCHIVE_ID='VIDEO_ARCHIVE_ID'
+VIDEO_BROADCAST_ID='VIDEO_BROADCAST_ID'
+VIDEO_CAPTIONS_ID='VIDEO_CAPTIONS_ID'
+VIDEO_EC_ID='VIDEO_EC_ID'
+
 # Voice
 VONAGE_VIRTUAL_NUMBER='VONAGE_VIRTUAL_NUMBER'
 VOICE_TO_NUMBER='VOICE_TO_NUMBER'

video/add-stream-to-archive.py

@@ -0,0 +1,32 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import AddStreamRequest
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_ARCHIVE_ID = os.getenv("VIDEO_ARCHIVE_ID")
+VIDEO_STREAM_ID = os.getenv("VIDEO_STREAM_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+params = AddStreamRequest(
+    stream_id=VIDEO_STREAM_ID,
+    has_video=True
+)
+
+vonage_client.video.add_stream_to_archive(
+    archive_id=VIDEO_ARCHIVE_ID,
+    params=params
+)
+
+print("=== Added Stream to Archive ===")

video/add-stream-to-broadcast.py

@@ -0,0 +1,32 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import AddStreamRequest
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_BROADCAST_ID = os.getenv("VIDEO_BROADCAST_ID")
+VIDEO_STREAM_ID = os.getenv("VIDEO_STREAM_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+params = AddStreamRequest(
+    stream_id=VIDEO_STREAM_ID,
+    has_video=True
+)
+
+vonage_client.video.add_stream_to_broadcast(
+    broadcast_id=VIDEO_BROADCAST_ID,
+    params=params
+)
+
+print("=== Added Stream to Broadcast ===")

video/change-archive-layout.py

@@ -0,0 +1,27 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import Archive, ComposedLayout, LayoutType
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_ARCHIVE_ID = os.getenv("VIDEO_ARCHIVE_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+archive: Archive = vonage_client.video.change_archive_layout(
+    archive_id=VIDEO_ARCHIVE_ID,
+    layout=ComposedLayout(type=LayoutType.VERTICAL_PRESENTATION),
+)
+
+print("=== Changed Archive Layout ===")
+print(json.dumps(archive.model_dump(), indent=2))

video/change-broadcast-layout.py

@@ -0,0 +1,27 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import Broadcast, ComposedLayout, LayoutType
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_BROADCAST_ID = os.getenv("VIDEO_BROADCAST_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+broadcast: Broadcast = vonage_client.video.change_broadcast_layout(
+    broadcast_id=VIDEO_BROADCAST_ID,
+    layout=ComposedLayout(type=LayoutType.VERTICAL_PRESENTATION),
+)
+
+print("=== Changed Broadcast Layout ===")
+print(json.dumps(broadcast.model_dump(), indent=2))

video/create-session.py

@@ -0,0 +1,31 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import SessionOptions
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+options = SessionOptions(
+    location="125.125.224.224",
+    e2ee="false",
+    media_mode="routed",
+    archive_mode="manual",
+    archiveName="TEST",
+    archiveResolution="1920x1080"
+)
+session = vonage_client.video.create_session(options)
+
+print("=== Created Session ===")
+print(json.dumps(session.model_dump(), indent=2))

video/generate-client-token.py

@@ -0,0 +1,34 @@
+import os
+from dotenv import load_dotenv
+import time
+
+from vonage import Auth, Vonage
+from vonage_video.models import TokenOptions
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_SESSION_ID = os.getenv("VIDEO_SESSION_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+token = vonage_client.video.generate_client_token(
+    TokenOptions(
+        session_id=VIDEO_SESSION_ID,
+        role="moderator",
+        connection_data="",
+        expire_time=int(time.time()) + 600,  # 600sec=10min
+    )
+)
+
+if isinstance(token, bytes):
+    token = token.decode("utf-8")
+
+print("=== Generated token ===")
+print(token)

video/get-archive.py

@@ -0,0 +1,24 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import Archive
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_ARCHIVE_ID = os.getenv("VIDEO_ARCHIVE_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+archive: Archive = vonage_client.video.get_archive(VIDEO_ARCHIVE_ID)
+
+print("=== Got Archive ===")
+print(json.dumps(archive.model_dump(), indent=2))

video/get-broadcast.py

@@ -0,0 +1,24 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import Broadcast
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_BROADCAST_ID = os.getenv("VIDEO_BROADCAST_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+broadcast: Broadcast = vonage_client.video.get_broadcast(VIDEO_BROADCAST_ID)
+
+print("=== Got a Broadcast ===")
+print(json.dumps(broadcast.model_dump(), indent=2))

video/get-experience-composer.py

@@ -0,0 +1,25 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import ExperienceComposer
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_EC_ID = os.getenv("VIDEO_EC_ID")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+experience_composer: ExperienceComposer = vonage_client.video.get_experience_composer(
+    VIDEO_EC_ID)
+
+print("=== Got ExperienceComposer ===")
+print(json.dumps(experience_composer.model_dump(), indent=2))

video/initiate-sip-call.py

@@ -0,0 +1,40 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import InitiateSipRequest, SipAuth, SipCall, SipOptions, TokenOptions
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+VIDEO_SESSION_ID = os.getenv("VIDEO_SESSION_ID")
+VIDEO_TOKEN = os.getenv("VIDEO_TOKEN")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+options = SipOptions(
+    uri=f'sip:...@sip.nexmo.com;transport=tls',
+    from_=f'...@nexmo.com',
+    headers={'header_key': 'header_value'},
+    auth=SipAuth(username='...', password='...'),
+    secure=False,
+    video=False,
+    observe_force_mute=True,
+)
+
+params = InitiateSipRequest(
+    session_id=VIDEO_SESSION_ID,
+    token=VIDEO_TOKEN,
+    sip=options
+)
+sip_call: SipCall = vonage_client.video.initiate_sip_call(params)
+
+print("=== Initiated SIP Call ===")
+print(json.dumps(sip_call.model_dump(), indent=2))

video/list-archives.py

@@ -0,0 +1,27 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import ListArchivesFilter
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+filter = ListArchivesFilter(offset=0, page_size=5)
+archive_list, total, next = vonage_client.video.list_archives(filter=filter)
+
+print("=== Total Archives ===")
+print(total)
+print("=== Listed Archives ===")
+for archive in archive_list:
+    print(json.dumps(archive.model_dump(), indent=2))

video/list-broadcasts.py

@@ -0,0 +1,28 @@
+import os
+from dotenv import load_dotenv
+import json
+
+from vonage import Auth, Vonage
+from vonage_video.models import ListBroadcastsFilter
+
+load_dotenv()
+
+VONAGE_APPLICATION_ID = os.getenv("VONAGE_APPLICATION_ID")
+VONAGE_PRIVATE_KEY = os.getenv("VONAGE_PRIVATE_KEY")
+
+vonage_client = Vonage(
+    Auth(
+        application_id=VONAGE_APPLICATION_ID,
+        private_key=VONAGE_PRIVATE_KEY,
+    )
+)
+
+filter = ListBroadcastsFilter(offset=0, page_size=5)
+broadcast_list, total, next = vonage_client.video.list_broadcasts(
+    filter=filter)
+
+print("=== Total Broadcasts ===")
+print(total)
+print("=== Listed Broadcasts ===")
+for broadcast in broadcast_list:
+    print(json.dumps(broadcast.model_dump(), indent=2))