Added in API level 23

VideoProfile

Kotlin |Java

public class VideoProfile
extends Object implements Parcelable

java.lang.Object
↳	android.telecom.VideoProfile

Represents attributes of video calls.

Summary

Nested classes
`class`	`VideoProfile.CameraCapabilities` Represents the camera capabilities important to a Video Telephony provider.

Constants
`int`	`QUALITY_DEFAULT` Use default video quality.
`int`	`QUALITY_HIGH` "High" video quality.
`int`	`QUALITY_LOW` "Low" video quality.
`int`	`QUALITY_MEDIUM` "Medium" video quality.
`int`	`STATE_AUDIO_ONLY` Used when answering or dialing a call to indicate that the call does not have a video component.
`int`	`STATE_BIDIRECTIONAL` Video signal is bi-directional.
`int`	`STATE_PAUSED` Video is paused.
`int`	`STATE_RX_ENABLED` Video reception is enabled.
`int`	`STATE_TX_ENABLED` Video transmission is enabled.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<VideoProfile>`	`CREATOR` Responsible for creating VideoProfile objects from deserialized Parcels.

Public constructors
`VideoProfile(int videoState)` Creates an instance of the VideoProfile
`VideoProfile(int videoState, int quality)` Creates an instance of the VideoProfile

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable's marshalled representation.
`int`	`getQuality()` The desired video quality for the call.
`int`	`getVideoState()` The video state of the call.
`static boolean`	`isAudioOnly(int videoState)` Indicates whether the video state is audio only.
`static boolean`	`isBidirectional(int videoState)` Indicates whether the video state is bi-directional.
`static boolean`	`isPaused(int videoState)` Indicates whether the video state is paused.
`static boolean`	`isReceptionEnabled(int videoState)` Indicates whether the video state has video reception enabled.
`static boolean`	`isTransmissionEnabled(int videoState)` Indicates whether the video state has video transmission enabled.
`static boolean`	`isVideo(int videoState)` Indicates whether video transmission or reception is enabled for a video state.
`String`	`toString()` Returns a string representation of the object.
`static String`	`videoStateToString(int videoState)` Generates a string representation of a video state.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

QUALITY_DEFAULT

Added in API level 23

public static final int QUALITY_DEFAULT

Use default video quality.

Constant Value: 4 (0x00000004)

QUALITY_HIGH

Added in API level 23

public static final int QUALITY_HIGH

"High" video quality.

Constant Value: 1 (0x00000001)

QUALITY_LOW

Added in API level 23

public static final int QUALITY_LOW

"Low" video quality.

Constant Value: 3 (0x00000003)

QUALITY_MEDIUM

Added in API level 23

public static final int QUALITY_MEDIUM

"Medium" video quality.

Constant Value: 2 (0x00000002)

STATE_AUDIO_ONLY

Added in API level 23

public static final int STATE_AUDIO_ONLY

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:

 // This is the incorrect way to check for an audio-only call.
 if (videoState == VideoProfile.STATE_AUDIO_ONLY) {
      // Handle audio-only call.
 }

Instead, use the VideoProfile.isAudioOnly(int) helper function to check if a video state represents an audio-only call:

 // This is the correct way to check for an audio-only call.
 if (VideoProfile.isAudioOnly(videoState)) {
      // Handle audio-only call.
 }

Constant Value: 0 (0x00000000)

STATE_BIDIRECTIONAL

Added in API level 23

public static final int STATE_BIDIRECTIONAL

Video signal is bi-directional.

Constant Value: 3 (0x00000003)

STATE_PAUSED

Added in API level 23

public static final int STATE_PAUSED

Video is paused.

Constant Value: 4 (0x00000004)

STATE_RX_ENABLED

Added in API level 23

public static final int STATE_RX_ENABLED

Video reception is enabled.

Constant Value: 2 (0x00000002)

STATE_TX_ENABLED

Added in API level 23

public static final int STATE_TX_ENABLED

Video transmission is enabled.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 23

public static final Creator<VideoProfile> CREATOR

Responsible for creating VideoProfile objects from deserialized Parcels.

Public constructors

VideoProfile

Added in API level 23

public VideoProfile (int videoState)

Creates an instance of the VideoProfile

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

VideoProfile

Added in API level 23

public VideoProfile (int videoState, 
                int quality)

Creates an instance of the VideoProfile

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`
`quality`	`int`: The video quality. Value is android.telecom.VideoProfile.QUALITY_UNKNOWN, `QUALITY_HIGH`, `QUALITY_MEDIUM`, `QUALITY_LOW`, or `QUALITY_DEFAULT`

Public methods

describeContents

Added in API level 23

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
`int`	a bitmask indicating the set of special object types marshalled by the Parcelable.

getQuality

Added in API level 23

public int getQuality ()

The desired video quality for the call. Valid values: VideoProfile.QUALITY_HIGH, VideoProfile.QUALITY_MEDIUM, VideoProfile.QUALITY_LOW, VideoProfile.QUALITY_DEFAULT.

Returns
`int`	Value is android.telecom.VideoProfile.QUALITY_UNKNOWN, `QUALITY_HIGH`, `QUALITY_MEDIUM`, `QUALITY_LOW`, or `QUALITY_DEFAULT`

getVideoState

Added in API level 23

public int getVideoState ()

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.

Returns
`int`	Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

isAudioOnly

Added in API level 23

public static boolean isAudioOnly (int videoState)

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 `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if the video state is audio only, `false` otherwise.

isBidirectional

Added in API level 23

public static boolean isBidirectional (int videoState)

Indicates whether the video state is bi-directional.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if the video is bi-directional, `false` otherwise.

isPaused

Added in API level 23

public static boolean isPaused (int videoState)

Indicates whether the video state is paused.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if the video is paused, `false` otherwise.

isReceptionEnabled

Added in API level 23

public static boolean isReceptionEnabled (int videoState)

Indicates whether the video state has video reception enabled.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if video reception is enabled, `false` otherwise.

isTransmissionEnabled

Added in API level 23

public static boolean isTransmissionEnabled (int videoState)

Indicates whether the video state has video transmission enabled.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if video transmission is enabled, `false` otherwise.

isVideo

Added in API level 23

public static boolean isVideo (int videoState)

Indicates whether video transmission or reception is enabled for a video state.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`boolean`	`True` if video transmission or reception is enabled, `false` otherwise.

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

videoStateToString

Added in API level 23

public static String videoStateToString (int videoState)

Generates a string representation of a video state.

Parameters
`videoState`	`int`: The video state. Value is either `0` or a combination of `STATE_AUDIO_ONLY`, `STATE_TX_ENABLED`, `STATE_RX_ENABLED`, `STATE_BIDIRECTIONAL`, and `STATE_PAUSED`

Returns
`String`	String representation of the video state.

writeToParcel

Added in API level 23

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`.

VideoProfile

Summary

Nested classes

Constants

Inherited constants

Fields

Public constructors

Public methods

Inherited methods

Constants

QUALITY_DEFAULT

QUALITY_HIGH

QUALITY_LOW

QUALITY_MEDIUM

STATE_AUDIO_ONLY

STATE_BIDIRECTIONAL

STATE_PAUSED

STATE_RX_ENABLED

STATE_TX_ENABLED

Fields

CREATOR

Public constructors

VideoProfile

VideoProfile

Public methods

describeContents

getQuality

getVideoState

isAudioOnly

isBidirectional

isPaused

isReceptionEnabled

isTransmissionEnabled

isVideo

toString

videoStateToString

writeToParcel