public class JibriIq
extends org.jivesoftware.smack.packet.IQ
JibriIq.Action.START
to Jibri.
2. Jibri replies with RESULT and status JibriIq.Status.PENDING
.
3. Jibri sends SET IQ with status JibriIq.Status.ON
once recording actually
starts.
Stop the recording:
1. Send Jibri IQ with JibriIq.Action.STOP
to Jibri.
2. Jibri replies with JibriIq.Status.OFF
immediately if the recording has
been stopped already or sends separate Jibri SET IQ later on if it takes
more time.Modifier and Type | Class and Description |
---|---|
static class |
JibriIq.Action
Enumerative value of attribute "action" in recording extension.
|
static class |
JibriIq.RecordingMode
Enumerates available recording modes stored under
RECORDING_MODE_ATTR_NAME . |
static class |
JibriIq.Status
The enumeration of recording status values.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTION_ATTR_NAME
Attribute name of "action".
|
(package private) static java.lang.String |
DISPLAY_NAME_ATTR_NAME
The name of XML attribute name which holds the display name which will be
used by Jibri participant when it enters Jitsi Meet conference.
|
static java.lang.String |
ELEMENT_NAME
XML element name of the Jibri IQ.
|
static java.lang.String |
NAMESPACE
XML namespace of the Jibri IQ.
|
(package private) static java.lang.String |
RECORDING_MODE_ATTR_NAME
The name of XML attribute which stores the recording mode which can be
either 'stream' or 'file'.
|
(package private) static java.lang.String |
ROOM_ATTR_NAME
The name of XML attribute which stores the name of the conference room to
be recorded.
|
(package private) static java.lang.String |
SIP_ADDRESS_ATTR_NAME
The name of XML attribute which stores SIP address.
|
(package private) static java.lang.String |
STATUS_ATTR_NAME
The name of XML attribute which stores the recording status.
|
(package private) static java.lang.String |
STREAM_ID_ATTR_NAME
The name of XML attribute which stores the stream id.
|
Constructor and Description |
---|
JibriIq() |
Modifier and Type | Method and Description |
---|---|
JibriIq.Action |
getAction()
Returns the value of 'action' attribute.
|
java.lang.String |
getChildElementXML() |
java.lang.String |
getDisplayName() |
org.jivesoftware.smack.packet.XMPPError |
getError()
Returns
XMPPError with Jibri error details when the status is
JibriIq.Status.FAILED . |
JibriIq.RecordingMode |
getRecordingMode()
Returns the value of 'recording_mode' attribute.
|
java.lang.String |
getRoom()
Returns the value of
ROOM_ATTR_NAME attribute. |
java.lang.String |
getSipAddress() |
JibriIq.Status |
getStatus()
Returns the value of 'status' attribute.
|
java.lang.String |
getStreamId()
Returns the value of
STREAM_ID_ATTR_NAME attribute. |
void |
setAction(JibriIq.Action action)
Sets the value of 'action' attribute.
|
void |
setDisplayName(java.lang.String displayName)
Sets new value for
DISPLAY_NAME_ATTR_NAME |
void |
setRecordingMode(JibriIq.RecordingMode mode)
Sets the value of 'recording_mode' attribute.
|
void |
setRoom(java.lang.String room)
Sets the value for
ROOM_ATTR_NAME attribute. |
void |
setSipAddress(java.lang.String sipAddress)
Sets new value for
SIP_ADDRESS_ATTR_NAME |
void |
setStatus(JibriIq.Status status)
Sets the value of 'status' attribute.
|
void |
setStreamId(java.lang.String streamId)
Sets the value for
STREAM_ID_ATTR_NAME attribute. |
void |
setXMPPError(org.jivesoftware.smack.packet.XMPPError error)
Sets the XMPPError which will provide details about Jibri
failure.
|
createErrorResponse, createResultIQ, getType, setType, toXML
addExtension, deleteProperty, equals, getDefaultLanguage, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo
public static final java.lang.String ACTION_ATTR_NAME
static final java.lang.String DISPLAY_NAME_ATTR_NAME
public static final java.lang.String ELEMENT_NAME
public static final java.lang.String NAMESPACE
static final java.lang.String SIP_ADDRESS_ATTR_NAME
static final java.lang.String STATUS_ATTR_NAME
static final java.lang.String STREAM_ID_ATTR_NAME
static final java.lang.String RECORDING_MODE_ATTR_NAME
STREAM_ID_ATTR_NAME
is, then it defaults to 'stream'. But if
the STREAM_ID_ATTR_NAME
is not present then it defaults to
'file'. Note that the defaults logic is handled on Jicofo level rather
than this packet's extension implementation.
In the 'stream' mode Jibri live streams the conference recording.
The 'file' mode makes Jibri write the recording to a file.static final java.lang.String ROOM_ATTR_NAME
public java.lang.String getDisplayName()
DISPLAY_NAME_ATTR_NAME
public void setDisplayName(java.lang.String displayName)
DISPLAY_NAME_ATTR_NAME
displayName
- the new display name to be setpublic java.lang.String getSipAddress()
SIP_ADDRESS_ATTR_NAME
public void setSipAddress(java.lang.String sipAddress)
SIP_ADDRESS_ATTR_NAME
sipAddress
- the new SIP address to be setpublic java.lang.String getStreamId()
STREAM_ID_ATTR_NAME
attribute.public void setStreamId(java.lang.String streamId)
STREAM_ID_ATTR_NAME
attribute.streamId
- a String for the stream id attribute or
null to remove it from XML element.public java.lang.String getRoom()
ROOM_ATTR_NAME
attribute.room
public void setRoom(java.lang.String room)
ROOM_ATTR_NAME
attribute.room
- a String for the room attribute or null to
remove it from XML element.room
public java.lang.String getChildElementXML()
getChildElementXML
in class org.jivesoftware.smack.packet.IQ
public void setAction(JibriIq.Action action)
action
- the value to be set as 'action' attribute of this IQ.public JibriIq.Action getAction()
public JibriIq.RecordingMode getRecordingMode()
RECORDING_MODE_ATTR_NAME
public void setRecordingMode(JibriIq.RecordingMode mode)
mode
- the new value to set as the recording mode attribute of this
IQ instance.RECORDING_MODE_ATTR_NAME
public void setStatus(JibriIq.Status status)
public JibriIq.Status getStatus()
public void setXMPPError(org.jivesoftware.smack.packet.XMPPError error)
JibriIq.Status.FAILED
.error
- XMPPError to be set on this JibriIq
instance.public org.jivesoftware.smack.packet.XMPPError getError()
XMPPError
with Jibri error details when the status is
JibriIq.Status.FAILED
.getError
in class org.jivesoftware.smack.packet.Packet
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.