AliVCSDK 6.17.0
阿里云音视频SDK,为视频开发者提供一站式接入服务
 
Loading...
Searching...
No Matches
com.alivc.live.pusher.AlivcLiveMixStream Class Reference

The position info of each sub stream when mixing stream on the cloud. More...

Public Member Functions

String getUserId ()
 
void setUserId (String userId)
 
int getX ()
 
void setX (int x)
 
int getY ()
 
void setY (int y)
 
int getWidth ()
 
void setWidth (int width)
 
int getHeight ()
 
void setHeight (int height)
 
int getZOrder ()
 
void setZOrder (int zOrder)
 
AlivcLiveMixStreamType getMixStreamType ()
 
void setMixStreamType (AlivcLiveMixStreamType mixStreamType)
 
AlivcLiveMixSourceType getMixSourceType ()
 
void setMixSourceType (AlivcLiveMixSourceType mixSourceType)
 
String getBackgroundImageUrl ()
 
void setBackgroundImageUrl (String backgroundImageUrl)
 
String toString ()
 

Public Attributes

String userId
 
int x
 
int y
 
int width
 
int height
 
int zOrder
 
AlivcLiveMixStreamType mixStreamType
 
AlivcLiveMixSourceType mixSourceType
 
String backgroundImageUrl
 

Detailed Description

The position info of each sub stream when mixing stream on the cloud.

Author
aliyun live push sdk
Attention
This API is only supported in the interactive mode currently
Note
Refer to the Push Demo for common layout formats
Corresponding to the interface: com.alivc.live.pusher.AlivcLivePusher#setLiveMixTranscodingConfig(com.alivc.live.pusher.AlivcLiveTranscodingConfig)

Definition at line 12 of file AlivcLiveMixStream.java.

Member Function Documentation

◆ getBackgroundImageUrl()

String com.alivc.live.pusher.AlivcLiveMixStream.getBackgroundImageUrl ( )

Get background image network address

Returns
Background image network address

Definition at line 238 of file AlivcLiveMixStream.java.

◆ getHeight()

int com.alivc.live.pusher.AlivcLiveMixStream.getHeight ( )

Get the height of the layer

Returns
the height of the layer
Note
pixel value

Definition at line 163 of file AlivcLiveMixStream.java.

◆ getMixSourceType()

AlivcLiveMixSourceType com.alivc.live.pusher.AlivcLiveMixStream.getMixSourceType ( )

Definition at line 223 of file AlivcLiveMixStream.java.

◆ getMixStreamType()

AlivcLiveMixStreamType com.alivc.live.pusher.AlivcLiveMixStream.getMixStreamType ( )

Get mix stream type

Returns
mix stream type
See also
AlivcLiveMixStreamType

Definition at line 207 of file AlivcLiveMixStream.java.

◆ getUserId()

String com.alivc.live.pusher.AlivcLiveMixStream.getUserId ( )

Get the user id from mix sub stream

Returns
user id
Note
Same as the 'userId' in the push/pull url

Definition at line 75 of file AlivcLiveMixStream.java.

◆ getWidth()

int com.alivc.live.pusher.AlivcLiveMixStream.getWidth ( )

Get the width of the layer

Returns
the width of the layer
Note
pixel value

Definition at line 141 of file AlivcLiveMixStream.java.

◆ getX()

int com.alivc.live.pusher.AlivcLiveMixStream.getX ( )

Get the X coordinate from the layer position

Returns
the X coordinate of the layer position
Note
pixel value

Definition at line 97 of file AlivcLiveMixStream.java.

◆ getY()

int com.alivc.live.pusher.AlivcLiveMixStream.getY ( )

Get the Y coordinate from the layer position

Returns
the Y coordinate from the layer position
Note
pixel value

Definition at line 119 of file AlivcLiveMixStream.java.

◆ getZOrder()

int com.alivc.live.pusher.AlivcLiveMixStream.getZOrder ( )

Get the zOrder of the layer

Returns
the zOrder of the layer
Note
(1 - 15), can not be the same

Definition at line 185 of file AlivcLiveMixStream.java.

◆ setBackgroundImageUrl()

void com.alivc.live.pusher.AlivcLiveMixStream.setBackgroundImageUrl ( String  backgroundImageUrl)

Set background image network address

Parameters
backgroundImageUrlBackground image network address
Note
When the user turns off the camera or does not enter the room, this image will be filled in the layout position

Definition at line 249 of file AlivcLiveMixStream.java.

◆ setHeight()

void com.alivc.live.pusher.AlivcLiveMixStream.setHeight ( int  height)

Set the height of the layer

Parameters
heightthe height of the layer
Note
pixel value

Definition at line 174 of file AlivcLiveMixStream.java.

◆ setMixSourceType()

void com.alivc.live.pusher.AlivcLiveMixStream.setMixSourceType ( AlivcLiveMixSourceType  mixSourceType)

Definition at line 228 of file AlivcLiveMixStream.java.

◆ setMixStreamType()

void com.alivc.live.pusher.AlivcLiveMixStream.setMixStreamType ( AlivcLiveMixStreamType  mixStreamType)

Set mix stream type

Parameters
mixStreamTypemix stream type
See also
AlivcLiveMixStreamType

Definition at line 218 of file AlivcLiveMixStream.java.

◆ setUserId()

void com.alivc.live.pusher.AlivcLiveMixStream.setUserId ( String  userId)

Set the user id of mix sub stream

Parameters
userIduser id
Note
Same as the 'userId' in the push/pull url

Definition at line 86 of file AlivcLiveMixStream.java.

◆ setWidth()

void com.alivc.live.pusher.AlivcLiveMixStream.setWidth ( int  width)

Set the width of the layer

Parameters
widththe width of the layer
Note
pixel value

Definition at line 152 of file AlivcLiveMixStream.java.

◆ setX()

void com.alivc.live.pusher.AlivcLiveMixStream.setX ( int  x)

Set the X coordinate of the layer position

Parameters
xthe X coordinate of the layer position
Note
pixel value

Definition at line 108 of file AlivcLiveMixStream.java.

◆ setY()

void com.alivc.live.pusher.AlivcLiveMixStream.setY ( int  y)

Set the Y coordinate of the layer position

Parameters
ythe Y coordinate of the layer position
Note
pixel value

Definition at line 130 of file AlivcLiveMixStream.java.

◆ setZOrder()

void com.alivc.live.pusher.AlivcLiveMixStream.setZOrder ( int  zOrder)

Set the zOrder of the layer

Parameters
zOrderthe zOrder of the layer
Note
(1 - 15), can not be the same

Definition at line 196 of file AlivcLiveMixStream.java.

◆ toString()

String com.alivc.live.pusher.AlivcLiveMixStream.toString ( )

Definition at line 254 of file AlivcLiveMixStream.java.

Member Data Documentation

◆ backgroundImageUrl

String com.alivc.live.pusher.AlivcLiveMixStream.backgroundImageUrl

Background image network address of sub stream

Note
When the user turns off the camera or does not enter the room, this image will be filled in the layout position

Definition at line 66 of file AlivcLiveMixStream.java.

◆ height

int com.alivc.live.pusher.AlivcLiveMixStream.height

The height of the sub stream layer (absolute pixel value)

Definition at line 37 of file AlivcLiveMixStream.java.

◆ mixSourceType

AlivcLiveMixSourceType com.alivc.live.pusher.AlivcLiveMixStream.mixSourceType

The video source type of the subpage stream

Note
SOURCE_CAMERA: camera stream,SOURCE_SCREEN: screenstream

Definition at line 59 of file AlivcLiveMixStream.java.

◆ mixStreamType

AlivcLiveMixStreamType com.alivc.live.pusher.AlivcLiveMixStream.mixStreamType

The types of streams mixed into sub stream

Note
AUDIO_VIDEO: mix audio and video, PURE_AUDIO: mix audio only, PURE_VIDEO: mix video only
See also
Mute audio in a battle

Definition at line 52 of file AlivcLiveMixStream.java.

◆ userId

String com.alivc.live.pusher.AlivcLiveMixStream.userId

User ID corresponding to the sub stream

Definition at line 17 of file AlivcLiveMixStream.java.

◆ width

int com.alivc.live.pusher.AlivcLiveMixStream.width

The width of the sub stream layer (absolute pixel value)

Definition at line 32 of file AlivcLiveMixStream.java.

◆ x

int com.alivc.live.pusher.AlivcLiveMixStream.x

Sub stream layer position x coordinate

Definition at line 22 of file AlivcLiveMixStream.java.

◆ y

int com.alivc.live.pusher.AlivcLiveMixStream.y

Sub stream layer position y coordinate

Definition at line 27 of file AlivcLiveMixStream.java.

◆ zOrder

int com.alivc.live.pusher.AlivcLiveMixStream.zOrder

The hierarchy of sub stream layers

Note
[1, 15], can not be the same

Definition at line 44 of file AlivcLiveMixStream.java.