Add layout prop to RoomSession.play() (#562)

* add missing layout prop * add changeset
signalwire · Jun 10, 2022 · 02d97de · 02d97de
1 parent bfbb670
commit 02d97de
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/.changeset/hip-moose-perform.md b/.changeset/hip-moose-perform.md
@@ -0,0 +1,7 @@
+---
+'@signalwire/core': minor
+'@signalwire/js': minor
+'@signalwire/realtime-api': minor
+---
+
+Add `layout` property to RoomSession.play()
diff --git a/packages/core/src/rooms/methods.ts b/packages/core/src/rooms/methods.ts
@@ -217,6 +217,7 @@ export type PlayParams = {
  url: string
  volume?: number
  positions?: Record<string, VideoPosition>
+ layout?: string
 }
 export const play: RoomMethodDescriptor<any, PlayParams> = {
  value: function (params) {

diff --git a/packages/js/src/RoomSession.docs.ts b/packages/js/src/RoomSession.docs.ts
@@ -871,6 +871,10 @@ interface RoomControlMethodsInterfaceDocs {
  * special keywork `self` to refer to the id of the playback.
  */
  positions?: VideoPositions
+ /**
+ * Layout to change to for the duration of the playback.
+ */
+ layout?: string
  }): Promise<Rooms.RoomSessionPlayback>
 
  /**

diff --git a/packages/realtime-api/src/video/RoomSession.ts b/packages/realtime-api/src/video/RoomSession.ts
@@ -421,6 +421,10 @@ interface RoomSessionDocs extends RoomSessionMain {
  * special keywork `self` to refer to the id of the playback.
  */
  positions?: VideoPositions
+ /**
+ * Layout to change to for the duration of the playback.
+ */
+ layout?: string
  }): Promise<Rooms.RoomSessionPlayback>
 
  /**
@@ -586,7 +590,7 @@ export interface RoomSession
  extends AssertSameType<RoomSessionMain, RoomSessionDocs> {}
 
 export type RoomSessionUpdated = EntityUpdated<RoomSession>
-export interface RoomSessionFullState extends Omit<RoomSession, "members"> {
+export interface RoomSessionFullState extends Omit<RoomSession, 'members'> {
  /** List of members that are part of this room session */
  members?: RoomSessionMember[]
 }