Session
Class
constructor
parent_
class
name
codecs_
need_
resend
get_
stream_
transmitter_
type
list_
transmitters
new_
stream
set_
codec_
preferences
set_
send_
codec
start_
telephony_
event
stop_
telephony_
event
GJS API Reference
Farstream-0.1
Farstream
SessionClass
Class SessionClass
You must override at least new_stream in a subclass.
record
Hierarchy
SessionClass
Index
Constructors
constructor
Properties
parent_
class
name
Methods
codecs_
need_
resend
get_
stream_
transmitter_
type
list_
transmitters
new_
stream
set_
codec_
preferences
set_
send_
codec
start_
telephony_
event
stop_
telephony_
event
Constructors
constructor
new
Session
Class
(
)
:
Farstream
.
SessionClass
Returns
Farstream
.
SessionClass
Properties
parent_
class
parent_
class
:
Gst
.
ObjectClass
Static
name
name
:
string
Methods
codecs_
need_
resend
codecs_
need_
resend
(
session
:
Farstream
.
Session
, old_codecs
:
Farstream
.
Codec
[]
, new_codecs
:
Farstream
.
Codec
[]
)
:
Farstream
.
Codec
[]
Parameters
session:
Farstream
.
Session
old_codecs:
Farstream
.
Codec
[]
new_codecs:
Farstream
.
Codec
[]
Returns
Farstream
.
Codec
[]
get_
stream_
transmitter_
type
get_
stream_
transmitter_
type
(
session
:
Farstream
.
Session
, transmitter
:
string
)
:
GType
<
unknown
>
Parameters
session:
Farstream
.
Session
transmitter:
string
Returns
GType
<
unknown
>
list_
transmitters
list_
transmitters
(
session
:
Farstream
.
Session
)
:
string
[]
Parameters
session:
Farstream
.
Session
Returns
string
[]
new_
stream
new_
stream
(
session
:
Farstream
.
Session
, participant
:
Farstream
.
Participant
, direction
:
Farstream
.
StreamDirection
)
:
Farstream
.
Stream
Parameters
session:
Farstream
.
Session
participant:
Farstream
.
Participant
direction:
Farstream
.
StreamDirection
Returns
Farstream
.
Stream
set_
codec_
preferences
set_
codec_
preferences
(
session
:
Farstream
.
Session
, codec_preferences
:
Farstream
.
Codec
[]
)
:
boolean
Parameters
session:
Farstream
.
Session
codec_preferences:
Farstream
.
Codec
[]
Returns
boolean
set_
send_
codec
set_
send_
codec
(
session
:
Farstream
.
Session
, send_codec
:
Farstream
.
Codec
)
:
boolean
Parameters
session:
Farstream
.
Session
send_codec:
Farstream
.
Codec
Returns
boolean
start_
telephony_
event
start_
telephony_
event
(
session
:
Farstream
.
Session
, event
:
number
, volume
:
number
)
:
boolean
Parameters
session:
Farstream
.
Session
event:
number
volume:
number
Returns
boolean
stop_
telephony_
event
stop_
telephony_
event
(
session
:
Farstream
.
Session
)
:
boolean
Parameters
session:
Farstream
.
Session
Returns
boolean
Session
Class
constructor
parent_
class
name
codecs_
need_
resend
get_
stream_
transmitter_
type
list_
transmitters
new_
stream
set_
codec_
preferences
set_
send_
codec
start_
telephony_
event
stop_
telephony_
event
base64:eyJwYWdlTmF2aWdhdGlvbiI6W3siY2xhc3NOYW1lcyI6InRzZC1raW5kLWNvbnN0cnVjdG9yIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJGYXJzdHJlYW1fMF8xLkZhcnN0cmVhbS5TZXNzaW9uQ2xhc3MuaHRtbCNjb25zdHJ1Y3RvciIsIm5hbWUiOiJjb25zdHJ1Y3RvciIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtcHJvcGVydHkgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkZhcnN0cmVhbV8wXzEuRmFyc3RyZWFtLlNlc3Npb25DbGFzcy5odG1sI3BhcmVudF9jbGFzcyIsIm5hbWUiOiJwYXJlbnRfY2xhc3MiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLXByb3BlcnR5IHRzZC1wYXJlbnQta2luZC1jbGFzcyB0c2QtaXMtc3RhdGljIiwiaHJlZiI6IkZhcnN0cmVhbV8wXzEuRmFyc3RyZWFtLlNlc3Npb25DbGFzcy5odG1sI25hbWUiLCJuYW1lIjoibmFtZSIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJGYXJzdHJlYW1fMF8xLkZhcnN0cmVhbS5TZXNzaW9uQ2xhc3MuaHRtbCNjb2RlY3NfbmVlZF9yZXNlbmQiLCJuYW1lIjoiY29kZWNzX25lZWRfcmVzZW5kIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkZhcnN0cmVhbV8wXzEuRmFyc3RyZWFtLlNlc3Npb25DbGFzcy5odG1sI2dldF9zdHJlYW1fdHJhbnNtaXR0ZXJfdHlwZSIsIm5hbWUiOiJnZXRfc3RyZWFtX3RyYW5zbWl0dGVyX3R5cGUiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRmFyc3RyZWFtXzBfMS5GYXJzdHJlYW0uU2Vzc2lvbkNsYXNzLmh0bWwjbGlzdF90cmFuc21pdHRlcnMiLCJuYW1lIjoibGlzdF90cmFuc21pdHRlcnMiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRmFyc3RyZWFtXzBfMS5GYXJzdHJlYW0uU2Vzc2lvbkNsYXNzLmh0bWwjbmV3X3N0cmVhbSIsIm5hbWUiOiJuZXdfc3RyZWFtIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkZhcnN0cmVhbV8wXzEuRmFyc3RyZWFtLlNlc3Npb25DbGFzcy5odG1sI3NldF9jb2RlY19wcmVmZXJlbmNlcyIsIm5hbWUiOiJzZXRfY29kZWNfcHJlZmVyZW5jZXMiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRmFyc3RyZWFtXzBfMS5GYXJzdHJlYW0uU2Vzc2lvbkNsYXNzLmh0bWwjc2V0X3NlbmRfY29kZWMiLCJuYW1lIjoic2V0X3NlbmRfY29kZWMiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRmFyc3RyZWFtXzBfMS5GYXJzdHJlYW0uU2Vzc2lvbkNsYXNzLmh0bWwjc3RhcnRfdGVsZXBob255X2V2ZW50IiwibmFtZSI6InN0YXJ0X3RlbGVwaG9ueV9ldmVudCIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJGYXJzdHJlYW1fMF8xLkZhcnN0cmVhbS5TZXNzaW9uQ2xhc3MuaHRtbCNzdG9wX3RlbGVwaG9ueV9ldmVudCIsIm5hbWUiOiJzdG9wX3RlbGVwaG9ueV9ldmVudCIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX1dLCJjbGFzc05hbWVzIjoiY3VycmVudCB0c2Qta2luZC1jbGFzcyB0c2QtcGFyZW50LWtpbmQtbmFtZXNwYWNlIiwiaHJlZiI6IkZhcnN0cmVhbV8wXzEuRmFyc3RyZWFtLlNlc3Npb25DbGFzcy5odG1sIiwibmFtZSI6IlNlc3Npb25DbGFzcyJ9
You must override at least new_stream in a subclass.