org.linphone.core

Interface VideoDefinition

public interface VideoDefinition

This object represents a video definition, eg.

it's width, it's height and possibly it's name.
It is mostly used to configure the default video size sent by your camera
during a video call with Core.setPreferredVideoDefinition(org.linphone.core.VideoDefinition) method.

Method Summary

Modifier and Type	Method and Description
VideoDefinition	clone() Clone a video definition.
boolean	equals(VideoDefinition videoDefinition2) Tells whether two VideoDefinition objects are equal (the widths and the heights are the same but can be switched).
int	getHeight() Get the height of the video definition.
java.lang.String	getName() Get the name of the video definition.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
java.lang.Object	getUserData() Gets the object stored in this object user's data
int	getWidth() Get the width of the video definition.
boolean	isUndefined() Tells whether a VideoDefinition is undefined.
void	setDefinition(int width, int height) Set the width and the height of the video definition.
void	setHeight(int height) Set the height of the video definition.
void	setName(java.lang.String name) Set the name of the video definition.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
void	setWidth(int width) Set the width of the video definition.
boolean	strictEquals(VideoDefinition videoDefinition2) Tells whether two VideoDefinition objects are strictly equal (the widths are the same and the heights are the same).
java.lang.String	toString()

Method Detail

getHeight

int getHeight()

Get the height of the video definition.

Returns:

The height of the video definition

setHeight

void setHeight(int height)

Set the height of the video definition.

Parameters:

height - The height of the video definition

isUndefined

boolean isUndefined()

Tells whether a VideoDefinition is undefined.

Returns:

A boolean value telling whether the VideoDefinition is
undefined.

getName

@Nullable
java.lang.String getName()

Get the name of the video definition.

Returns:

The name of the video definition

setName

void setName(@Nullable
             java.lang.String name)

Set the name of the video definition.

Parameters:

name - The name of the video definition

getWidth

int getWidth()

Get the width of the video definition.

Returns:

The width of the video definition

setWidth

void setWidth(int width)

Set the width of the video definition.

Parameters:

width - The width of the video definition

clone

@NonNull
VideoDefinition clone()

Clone a video definition.

Returns:

The new clone of the video definition

equals

boolean equals(@NonNull
               VideoDefinition videoDefinition2)

Tells whether two VideoDefinition objects are equal (the widths and the
heights are the same but can be switched).

Parameters:

videoDefinition2 - VideoDefinition object

Returns:

A boolean value telling whether the two VideoDefinition objects
are equal.

setDefinition

void setDefinition(int width,
                   int height)

Set the width and the height of the video definition.

Parameters:

width - The width of the video definition

height - The height of the video definition

strictEquals

boolean strictEquals(@NonNull
                     VideoDefinition videoDefinition2)

Tells whether two VideoDefinition objects are strictly equal (the
widths are the same and the heights are the same).

Parameters:

videoDefinition2 - VideoDefinition object

Returns:

A boolean value telling whether the two VideoDefinition objects
are strictly equal.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object