/
spaces.ex
159 lines (113 loc) · 4.82 KB
/
spaces.ex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
defmodule Mux.Video.Spaces do
@moduledoc """
This module provides functions for managing Spaces in Mux Video. [API Documentation](https://docs.mux.com/api-reference/video#tag/spaces)
"""
alias Mux.{Base, Fixtures}
@path "/video/v1/spaces"
@doc """
Create a new space.
Returns `{:ok, space, %Tesla.Client{}}`.
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {:ok, space, _env} = Mux.Video.Spaces.create(client, %{type: "server", passthrough: "example", broadcasts: [%{passthrough: "example", live_stream_id: "vJvFbCojkuSDAAeEK4EddOA01wRqN1mP4", layout: "gallery", background: "https://example.com/background.jpg", resolution: "1920x1080"}]})
iex> space
#{inspect(Fixtures.space())}
"""
def create(client, params) do
Base.post(client, @path, params)
end
@doc """
List spaces.
Returns a tuple such as `{:ok, spaces, %Telsa.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {:ok, spaces, _env} = Mux.Video.Spaces.list(client)
iex> spaces
#{inspect([Fixtures.space(), Fixtures.space()])}
"""
def list(client, params \\ []), do: Base.get(client, @path, query: params)
@doc """
Retrieve a space by ID.
Returns a tuple such as `{:ok, space, %Telsa.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {:ok, space, _env} = Mux.Video.Spaces.get(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk")
iex> space
#{inspect(Fixtures.space())}
"""
def get(client, space_id, params \\ []) do
Base.get(client, "#{@path}/#{space_id}", query: params)
end
@doc """
Delete a space.
Returns a tuple such as `{:ok, "", %Telsa.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {status, "", _env} = Mux.Video.Spaces.delete(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk")
iex> status
:ok
"""
def delete(client, space_id, params \\ []) do
Base.delete(client, "#{@path}/#{space_id}", query: params)
end
@doc """
Create a new space broadcast.
Returns a tuple such as `{:ok, broadcast, %Tesla.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {:ok, broadcast, _env} = Mux.Video.Spaces.create_space_broadcast(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk", %{passthrough: "example", live_stream_id: "vJvFbCojkuSDAAeEK4EddOA01wRqN1mP4", layout: "gallery", background: "https://example.com/background.jpg", resolution: "1920x1080"})
iex> broadcast
#{inspect(Fixtures.broadcast())}
"""
def create_space_broadcast(client, space_id, params) do
Base.post(client, "#{@path}/#{space_id}/broadcasts", params)
end
@doc """
Retrieve a space broadcast.
Returns a tuple such as `{:ok, broadcast, %Tesla.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {:ok, broadcast, _env} = Mux.Video.Spaces.get_space_broadcast(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk", "fZw6qjWmKLmjfi0200NBzsgGrXZImT3KiJ")
iex> broadcast
#{inspect(Fixtures.broadcast())}
"""
def get_space_broadcast(client, space_id, broadcast_id, params \\ []) do
Base.get(client, "#{@path}/#{space_id}/broadcasts/#{broadcast_id}", query: params)
end
@doc """
Delete a space broadcast.
Returns a tuple such as `{:ok, "", %Tesla.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {status, "", _env} = Mux.Video.Spaces.delete_space_broadcast(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk", "fZw6qjWmKLmjfi0200NBzsgGrXZImT3KiJ")
iex> status
:ok
"""
def delete_space_broadcast(client, space_id, broadcast_id, params \\ []) do
Base.delete(client, "#{@path}/#{space_id}/broadcasts/#{broadcast_id}", query: params)
end
@doc """
Start a space broadcast.
Returns a tuple such as `{:ok, %{}, %Tesla.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {status, %{}, _env} = Mux.Video.Spaces.start_space_broadcast(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk", "fZw6qjWmKLmjfi0200NBzsgGrXZImT3KiJ")
iex> status
:ok
"""
def start_space_broadcast(client, space_id, broadcast_id) do
Base.post(client, "#{@path}/#{space_id}/broadcasts/#{broadcast_id}/start", %{})
end
@doc """
Stop a space broadcast.
Returns a tuple such as `{:ok, %{}, %Tesla.Env{}}`
## Examples
iex> client = Mux.Base.new("my_token_id", "my_token_secret")
iex> {status, %{}, _env} = Mux.Video.Spaces.stop_space_broadcast(client, "xe00FkgJMdZrYQ001VC53bd01lf9ADs6YWk", "fZw6qjWmKLmjfi0200NBzsgGrXZImT3KiJ")
iex> status
:ok
"""
def stop_space_broadcast(client, space_id, broadcast_id) do
Base.post(client, "#{@path}/#{space_id}/broadcasts/#{broadcast_id}/stop", %{})
end
end