VideoProfile
open class VideoProfile : Parcelable
| kotlin.Any | |
| ↳ | android.telecom.VideoProfile | 
Represents attributes of video calls.
Summary
| Nested classes | |
|---|---|
| Represents the camera capabilities important to a Video Telephony provider. | |
| Constants | |
|---|---|
| static Int | Use default video quality. | 
| static Int | "High" video quality. | 
| static Int | "Low" video quality. | 
| static Int | "Medium" video quality. | 
| static Int | Used when answering or dialing a call to indicate that the call does not have a video component. | 
| static Int | Video signal is bi-directional. | 
| static Int | Video is paused. | 
| static Int | Video reception is enabled. | 
| static Int | Video transmission is enabled. | 
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
| VideoProfile(videoState: Int)Creates an instance of the VideoProfile | |
| VideoProfile(videoState: Int, quality: Int)Creates an instance of the VideoProfile | |
| Public methods | |
|---|---|
| open Int | Describe the kinds of special objects contained in this Parcelable's marshalled representation. | 
| open Int | The desired video quality for the call. | 
| open Int | The video state of the call. | 
| open static Boolean | isAudioOnly(videoState: Int)Indicates whether the video state is audio only. | 
| open static Boolean | isBidirectional(videoState: Int)Indicates whether the video state is bi-directional. | 
| open static Boolean | Indicates whether the video state is paused. | 
| open static Boolean | isReceptionEnabled(videoState: Int)Indicates whether the video state has video reception enabled. | 
| open static Boolean | isTransmissionEnabled(videoState: Int)Indicates whether the video state has video transmission enabled. | 
| open static Boolean | Indicates whether video transmission or reception is enabled for a video state. | 
| open String | toString() | 
| open static String! | videoStateToString(videoState: Int)Generates a string representation of a video state. | 
| open Unit | writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. | 
| Properties | |
|---|---|
| static Parcelable.Creator<VideoProfile!> | Responsible for creating VideoProfile objects from deserialized Parcels. | 
Constants
QUALITY_DEFAULT
static val QUALITY_DEFAULT: Int
Use default video quality.
Value: 4QUALITY_MEDIUM
static val QUALITY_MEDIUM: Int
"Medium" video quality.
Value: 2STATE_AUDIO_ONLY
static val STATE_AUDIO_ONLY: Int
Used when answering or dialing a call to indicate that the call does not have a video component.
Should not be used in comparison checks to determine if a video state represents an audio-only call.
The following, for example, is not the correct way to check if a call is audio-only:
<code>// This is the incorrect way to check for an audio-only call. if (videoState == VideoProfile.STATE_AUDIO_ONLY) { // Handle audio-only call. } </code>
 Instead, use the VideoProfile.isAudioOnly(int) helper function to check if a video state represents an audio-only call: 
<code>// This is the correct way to check for an audio-only call. if (VideoProfile.isAudioOnly(videoState)) { // Handle audio-only call. } </code>
Value: 0STATE_BIDIRECTIONAL
static val STATE_BIDIRECTIONAL: Int
Video signal is bi-directional.
Value: 3STATE_RX_ENABLED
static val STATE_RX_ENABLED: Int
Video reception is enabled.
Value: 2STATE_TX_ENABLED
static val STATE_TX_ENABLED: Int
Video transmission is enabled.
Value: 1Public constructors
VideoProfile
VideoProfile(videoState: Int)
Creates an instance of the VideoProfile
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
VideoProfile
VideoProfile(
videoState: Int,
quality: Int)
Creates an instance of the VideoProfile
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| quality | Int: The video quality. Value is android.telecom.VideoProfile.QUALITY_UNKNOWN, android.telecom.VideoProfile#QUALITY_HIGH,android.telecom.VideoProfile#QUALITY_MEDIUM,android.telecom.VideoProfile#QUALITY_LOW, orandroid.telecom.VideoProfile#QUALITY_DEFAULT | 
Public methods
describeContents
open fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
| Return | |
|---|---|
| Int | a bitmask indicating the set of special object types marshalled by the Parcelable. | 
getQuality
open fun getQuality(): Int
The desired video quality for the call. Valid values: VideoProfile.QUALITY_HIGH, VideoProfile.QUALITY_MEDIUM, VideoProfile.QUALITY_LOW, VideoProfile.QUALITY_DEFAULT.
| Return | |
|---|---|
| Int | Value is android.telecom.VideoProfile.QUALITY_UNKNOWN, android.telecom.VideoProfile#QUALITY_HIGH,android.telecom.VideoProfile#QUALITY_MEDIUM,android.telecom.VideoProfile#QUALITY_LOW, orandroid.telecom.VideoProfile#QUALITY_DEFAULT | 
getVideoState
open fun getVideoState(): Int
The video state of the call. Valid values: VideoProfile.STATE_AUDIO_ONLY, VideoProfile.STATE_BIDIRECTIONAL, VideoProfile.STATE_TX_ENABLED, VideoProfile.STATE_RX_ENABLED, VideoProfile.STATE_PAUSED.
| Return | |
|---|---|
| Int | Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
isAudioOnly
open static fun isAudioOnly(videoState: Int): Boolean
Indicates whether the video state is audio only.
 Note: Considers only whether either both the STATE_RX_ENABLED or STATE_TX_ENABLED bits are off, but not STATE_PAUSED.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif the video state is audio only,falseotherwise. | 
isBidirectional
open static fun isBidirectional(videoState: Int): Boolean
Indicates whether the video state is bi-directional.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif the video is bi-directional,falseotherwise. | 
isPaused
open static fun isPaused(videoState: Int): Boolean
Indicates whether the video state is paused.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif the video is paused,falseotherwise. | 
isReceptionEnabled
open static fun isReceptionEnabled(videoState: Int): Boolean
Indicates whether the video state has video reception enabled.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif video reception is enabled,falseotherwise. | 
isTransmissionEnabled
open static fun isTransmissionEnabled(videoState: Int): Boolean
Indicates whether the video state has video transmission enabled.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif video transmission is enabled,falseotherwise. | 
isVideo
open static fun isVideo(videoState: Int): Boolean
Indicates whether video transmission or reception is enabled for a video state.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| Boolean | Trueif video transmission or reception is enabled,falseotherwise. | 
toString
open fun toString(): String
| Return | |
|---|---|
| String | a string representation of the object. | 
videoStateToString
open static fun videoStateToString(videoState: Int): String!
Generates a string representation of a video state.
| Parameters | |
|---|---|
| videoState | Int: The video state. Value is either 0or a combination ofandroid.telecom.VideoProfile#STATE_AUDIO_ONLY,android.telecom.VideoProfile#STATE_TX_ENABLED,android.telecom.VideoProfile#STATE_RX_ENABLED,android.telecom.VideoProfile#STATE_BIDIRECTIONAL, andandroid.telecom.VideoProfile#STATE_PAUSED | 
| Return | |
|---|---|
| String! | String representation of the video state. | 
writeToParcel
open fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
| dest | Parcel: The Parcel in which the object should be written. | 
| flags | Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. | 
Properties
CREATOR
static val CREATOR: Parcelable.Creator<VideoProfile!>
Responsible for creating VideoProfile objects from deserialized Parcels.
