blob: 84baf4637d5c94afb8c92253718e691507733a0f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.media;
import net.java.sip.communicator.service.protocol.*;
import java.text.*;
import java.net.*;
/**
* A CallSession contains parameters associated with a particular Call such as
* ports used for transmitting and sending media (audio video), a reference to
* the call itself and others. Call session instances are created through the
* <tt>openCallSession(Call)</tt> method of the MediaService.
* <p>
* One <tt>CallSession</tt> pertains to a single <tt>Call</tt> instance and a
* single <tt>Call</tt> may only be associated one <tt>CallSession</tt>
* instance.
* <p>
* A call session also allows signalling protocols to generate SDP offers and
* construct sdp answers.
*
* @author Emil Ivov
*/
public interface CallSession
{
/**
* The method is meant for use by protocol service implementations when
* willing to send an invitation to a remote callee.
*
* @return a String containing an SDP offer descibing parameters of the
* <tt>Call</tt> associated with this session.
* @throws MediaException code INTERNAL_ERROR if generating the offer fails
* for some reason.
*/
public String createSdpOffer()
throws MediaException;
/**
* The method is meant for use by protocol service implementations when
* willing to send an invitation to a remote callee. The intendedDestination
* parameter, may contain the address that the offer is to be sent to. In
* case it is null we'll try our best to determine a default local address.
*
* @param intendedDestination the address of the call participant that the
* descriptions is to be sent to.
* @return a new SDP description String advertising all params of
* <tt>callSession</tt>.
*
* @throws MediaException code SERVICE_NOT_STARTED if this method is called
* before the service was started.
*/
public String createSdpOffer(InetAddress intendedDestination)
throws MediaException;
/**
* The method is meant for use by protocol service implementations when
* willing to respond to an invitation received from a remote caller. Apart
* from simply generating an SDP response description, the method records
* details
*
* @param sdpOffer the SDP offer that we'd like to create an answer for.
* @param offerer the participant that has sent the offer.
*
* @return a String containing an SDP answer descibing parameters of the
* <tt>Call</tt> associated with this session and matching those advertised
* by the caller in their <tt>sdpOffer</tt>.
*
* @throws MediaException code INTERNAL_ERROR if processing the offer and/or
* generating the anser fail for some reason.
* @throws ParseException if <tt>sdpOfferStr</tt> does not contain a valid
* sdp string.
*/
public String processSdpOffer(CallParticipant offerer, String sdpOffer)
throws MediaException, ParseException;
/**
* The method is meant for use by protocol service implementations upon
* reception of an SDP answer in response to an offer sent by us earlier.
*
* @param sdpAnswer the SDP answer that we'd like to handle.
* @param responder the participant that has sent the answer.
*
* @throws MediaException code SERVICE_NOT_STARTED if this method is called
* before the service was started.
* @throws ParseException if <tt>sdpAnswerStr</tt> does not contain a valid
* sdp string.
*/
public void processSdpAnswer(CallParticipant responder, String sdpAnswer)
throws MediaException, ParseException;
/**
* Returns the port that we are using for receiving video data in this
* <tt>CallSession</tt>.
* <p>
* @return the port number we are using for receiving video data in this
* <tt>CallSession</tt>.
*/
public int getVideoPort();
/**
* Returns the port that we are using for receiving audio data in this
* <tt>CallSession</tt>.
* <p>
* @return the port number we are using for receiving audio data in this
* <tt>CallSession</tt>.
*/
public int getAudioPort();
}
|
