Adjust Positions (#451)

* Revert "remove positions arguments from codebase" This reverts commit b3d3988. * adjust position types * add changeset * dry a bit * export VideoPosition types
signalwire · Mar 4, 2022 · b1b022a · b1b022a
1 parent edfda1a
commit b1b022a
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 69 deletions.
diff --git a/.changeset/curly-trains-impress.md b/.changeset/curly-trains-impress.md
@@ -0,0 +1,7 @@
+---
+'@signalwire/core': patch
+'@signalwire/js': patch
+'@signalwire/realtime-api': patch
+---
+
+[internal] Adjust naming of positions
diff --git a/packages/core/src/rooms/methods.test.ts b/packages/core/src/rooms/methods.test.ts
@@ -93,7 +93,7 @@ describe('Room Custom Methods', () => {
 
  await instance.setPositions({
  positions: {
- 'cebecb3a-b9e4-499c-a707-0af96c110a04': 'standard',
+ 'cebecb3a-b9e4-499c-a707-0af96c110a04': 'auto',
  'aaaaaaa-b9e4-499c-a707-0af96c110a04': 'standard-1',
  },
  })
@@ -104,7 +104,7 @@ describe('Room Custom Methods', () => {
  params: {
  room_session_id: 'mocked',
  positions: {
- 'cebecb3a-b9e4-499c-a707-0af96c110a04': 'standard',
+ 'cebecb3a-b9e4-499c-a707-0af96c110a04': 'auto',
  'aaaaaaa-b9e4-499c-a707-0af96c110a04': 'standard-1',
  },
  },
@@ -123,7 +123,7 @@ describe('Room Custom Methods', () => {
 
  await instance.setMemberPosition({
  member_id: 'cebecb3a-b9e4-499c-a707-0af96c110a04',
- position: 'standard',
+ position: 'auto',
  })
  expect(instance.execute).toHaveBeenCalledTimes(1)
  expect(instance.execute).toHaveBeenCalledWith(
@@ -132,7 +132,7 @@ describe('Room Custom Methods', () => {
  params: {
  room_session_id: 'mocked',
  member_id: 'cebecb3a-b9e4-499c-a707-0af96c110a04',
- position: 'standard',
+ position: 'auto',
  },
  },
  {

diff --git a/packages/core/src/rooms/methods.ts b/packages/core/src/rooms/methods.ts
@@ -108,7 +108,7 @@ export const getMembers = createRoomMethod<{ members: VideoMemberEntity[] }>(
 )
 export interface SetLayoutParams {
  name: string
- // positions?: Record<string, VideoPosition>
+ positions?: Record<string, VideoPosition>
 }
 export const setLayout = createRoomMethod<BaseRPCResult, void>(
  'video.set_layout',
@@ -216,7 +216,7 @@ export const getPlaybacks = createRoomMethod<
 export type PlayParams = {
  url: string
  volume?: number
- // positions?: Record<string, VideoPosition>
+ positions?: Record<string, VideoPosition>
 }
 export const play: RoomMethodDescriptor<any, PlayParams> = {
  value: function (params) {

diff --git a/packages/core/src/types/video.ts b/packages/core/src/types/video.ts
@@ -36,9 +36,8 @@ export type RTCTrackEventName = 'track'
 
 export type VideoPosition =
  | 'self'
- // | 'reserved'
- // | `reserved-${number}`
- | 'standard'
+ | 'auto'
+ | `reserved-${number}`
  | `standard-${number}`
  | 'off-canvas'
 

diff --git a/packages/core/src/types/videoRoomSession.ts b/packages/core/src/types/videoRoomSession.ts
@@ -89,10 +89,10 @@ export interface VideoRoomSessionContract {
  setHideVideoMuted(value: boolean): Rooms.SetHideVideoMuted
  getLayouts(): Rooms.GetLayouts
  setLayout(params: Rooms.SetLayoutParams): Rooms.SetLayout
- // setPositions(params: Rooms.SetPositionsParams): Rooms.SetPositions
- // setMemberPosition(
- //  params: Rooms.SetMemberPositionParams
- // ): Rooms.SetMemberPosition
+ setPositions(params: Rooms.SetPositionsParams): Rooms.SetPositions
+ setMemberPosition(
+ params: Rooms.SetMemberPositionParams
+ ): Rooms.SetMemberPosition
  getRecordings(): Rooms.GetRecordings
  startRecording(): Promise<Rooms.RoomSessionRecording>
  getPlaybacks(): Rooms.GetPlaybacks

diff --git a/packages/js/src/BaseRoomSession.ts b/packages/js/src/BaseRoomSession.ts
@@ -352,8 +352,8 @@ export const RoomSessionAPI = extendComponent<
  getMembers: Rooms.getMembers,
  getLayouts: Rooms.getLayouts,
  setLayout: Rooms.setLayout,
- // setPositions: Rooms.setPositions,
- // setMemberPosition: Rooms.setMemberPosition,
+ setPositions: Rooms.setPositions,
+ setMemberPosition: Rooms.setMemberPosition,
  hideVideoMuted: Rooms.hideVideoMuted,
  showVideoMuted: Rooms.showVideoMuted,
  getRecordings: Rooms.getRecordings,

diff --git a/packages/js/src/RoomSession.docs.ts b/packages/js/src/RoomSession.docs.ts
@@ -1,4 +1,9 @@
-import type { AssertSameType, VideoPositions, Rooms } from '@signalwire/core'
+import type {
+ AssertSameType,
+ VideoPositions,
+ Rooms,
+ VideoPosition,
+} from '@signalwire/core'
 import { BaseRoomSession } from './BaseRoomSession'
 import { RoomSessionDevice } from './RoomSessionDevice'
 import { RoomSessionScreenShare } from './RoomSessionScreenShare'
@@ -849,10 +854,7 @@ interface RoomControlMethodsInterfaceDocs {
  play(params: {
  url: string
  volume?: number
- // positions?: Record<
- // string,
- // 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // >
+ positions?: VideoPositions
  }): Promise<Rooms.RoomSessionPlayback>
 }
 
@@ -903,30 +905,15 @@ interface RoomLayoutMethodsInterface {
  */
  setLayout(params: {
  name: string
- // positions?: Record<
- // string,
- // 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // >
+ positions?: VideoPositions
  }): Rooms.SetLayout
 
- // setPositions(params: {
- // positions: Record<
- // string,
- // | 'self'
- // | 'standard'
- // | `standard-${number}`
- // | 'off-canvas'
- // >
- // }): Promise<void>
-
- // setMemberPosition(params: {
- // memberId?: string
- // position:
- // | 'self'
- // | 'standard'
- // | `standard-${number}`
- // | 'off-canvas'
- // }): Promise<void>
+ setPositions(params: { positions: VideoPositions }): Promise<void>
+
+ setMemberPosition(params: {
+ memberId?: string
+ position: VideoPosition
+ }): Promise<void>
 }
 
 /**

diff --git a/packages/js/src/index.ts b/packages/js/src/index.ts
@@ -9,9 +9,9 @@
  * - {@link WebRTC}
  *
  * Video gives you access to the classes and methods that let you
- * interface with the backend Video APIs. Chat gives you access to the classes and functions that you need to create a real-time chat application. WebRTC 
+ * interface with the backend Video APIs. Chat gives you access to the classes and functions that you need to create a real-time chat application. WebRTC
  * contains several functions that are useful for interacting with the hardware of the user's device.
- * 
+ *
  *
  * Don't know where to start? Create an instance of
  * {@link Video.RoomSession} to join a room, use the {@link Chat.Client} constructor to start a chat application, or take a look at [Getting Started
@@ -87,6 +87,8 @@ export type {
  MemberTalkingEventNames,
  VideoMemberTalkingEventParams,
  InternalVideoMemberEntity,
+ VideoPosition,
+ VideoPositions,
 } from '@signalwire/core'
 
 /** @ignore */

diff --git a/packages/realtime-api/src/video/RoomSession.ts b/packages/realtime-api/src/video/RoomSession.ts
@@ -25,6 +25,8 @@ import {
  AssertSameType,
  BaseConsumer,
  EventEmitter,
+ VideoPosition,
+ VideoPositions,
 } from '@signalwire/core'
 import { RealTimeRoomApiEvents } from '../types'
 import { debounce } from '../utils/debounce'
@@ -309,25 +311,14 @@ interface RoomSessionDocs extends RoomSessionMain {
  * await roomSession.setLayout({name: "6x6"})
  * ```
  */
- setLayout(params: {
- name: string
- // positions?: Record<
- // string,
- // 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // >
- }): Promise<void>
+ setLayout(params: { name: string; positions?: VideoPositions }): Promise<void>
 
- // setPositions(params: {
- // positions: Record<
- // string,
- // 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // >
- // }): Promise<void>
+ setPositions(params: { positions: VideoPositions }): Promise<void>
 
- // setMemberPosition(params: {
- //  memberId?: string
- // position: 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // }): Promise<void>
+ setMemberPosition(params: {
+ memberId?: string
+  position: VideoPosition
+ }): Promise<void>
 
  /**
  * Obtains a list of recordings for the current room session.
@@ -338,7 +329,7 @@ interface RoomSessionDocs extends RoomSessionMain {
  * rec.recordings[0].id
  * rec.recordings[0].state
  * ```
- * 
+ *
  * @returns The returned objects contain all the properties of a
  * {@link RoomSessionRecording}, but no methods.
  */
@@ -359,7 +350,7 @@ interface RoomSessionDocs extends RoomSessionMain {
 
  /**
  * Obtains a list of playbacks for the current room session.
- * 
+ *
  * @example
  * ```js
  * const pl = await roomSession.startRecording()
@@ -391,10 +382,7 @@ interface RoomSessionDocs extends RoomSessionMain {
  play(params: {
  url: string
  volume?: number
- // positions?: Record<
- // string,
- // 'self' | 'standard' | `standard-${number}` | 'off-canvas'
- // >
+ positions?: VideoPositions
  }): Promise<Rooms.RoomSessionPlayback>
 
  /**
@@ -760,8 +748,8 @@ export const RoomSessionAPI = extendComponent<
  setHideVideoMuted: Rooms.setHideVideoMuted,
  getLayouts: Rooms.getLayouts,
  setLayout: Rooms.setLayout,
- // setPositions: Rooms.setPositions,
- // setMemberPosition: Rooms.setMemberPosition,
+ setPositions: Rooms.setPositions,
+ setMemberPosition: Rooms.setMemberPosition,
  getRecordings: Rooms.getRecordings,
  startRecording: Rooms.startRecording,
  getPlaybacks: Rooms.getPlaybacks,