Skip to content

Commit

Permalink
Fixed some errors in the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
fyhertz committed Aug 20, 2013
1 parent 18a826c commit 7d8931f
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 20 deletions.
2 changes: 1 addition & 1 deletion src/net/majorkernelpanic/streaming/Session.java
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public VideoStream getVideoTrack() {
/**
* Reference to the context is needed to aquire a MulticastLock.
* If the Session has a multicast destination is address such a lock will be aquired.
* @param A reference to the application context
* @param context reference to the application context
**/
public void setContext(Context context) {
mContext = context;
Expand Down
5 changes: 2 additions & 3 deletions src/net/majorkernelpanic/streaming/audio/AACStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@

/**
* A class for streaming AAC from the microphone of an android device using RTP.
* Call {@link #setDestinationAddress(java.net.InetAddress)}, {@link #prepare()} & {@link #start()} and that's it !
* Call {@link #setDestinationAddress(java.net.InetAddress)} & {@link #start()} and that's it !
* Call {@link #stop()} to stop the stream.
* Do not forget to call {@link #release()} when you're done.
*/
public class AACStream extends AudioStream {

Expand Down Expand Up @@ -111,7 +110,7 @@ private static boolean AACStreamingSupported() {
}

/**
* Some data (the actual sampling rate) needs to be stored once {@link #generateSessionDescription()} is called.
* Some data (the actual sampling rate used by the phone and the AAC profile) needs to be stored once {@link #generateSessionDescription()} is called.
* @param prefs The SharedPreferences that will be used to store the sampling rate
*/
public void setPreferences(SharedPreferences prefs) {
Expand Down
3 changes: 1 addition & 2 deletions src/net/majorkernelpanic/streaming/audio/AMRNBStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,8 @@

/**
* A class for streaming AMR-NB from the microphone of an android device using RTP.
* Call {@link #setDestinationAddress(java.net.InetAddress)}, {@link #prepare()} & {@link #start()} and that's it !
* Call {@link #setDestinationAddress(java.net.InetAddress)} & {@link #start()} and that's it !
* Call {@link #stop()} to stop the stream.
* Do not forget to call {@link #release()} when you're done.
*/
public class AMRNBStream extends AudioStream {

Expand Down
2 changes: 1 addition & 1 deletion src/net/majorkernelpanic/streaming/rtp/RtpSocket.java
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public int getLocalPort() {

/**
* Returns an available buffer from the FIFO, it can then directly be modified.
* Call {@link commitBuffer(int)} to send it over the network.
* Call {@link #commitBuffer(int)} to send it over the network.
* @throws InterruptedException
**/
public byte[] requestBuffer() throws InterruptedException {
Expand Down
3 changes: 1 addition & 2 deletions src/net/majorkernelpanic/streaming/video/H263Stream.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@
* A class for streaming H.263 from the camera of an android device using RTP.
* Call {@link #setDestinationAddress(java.net.InetAddress)}, {@link #setDestinationPorts(int)},
* {@link #setVideoSize(int, int)}, {@link #setVideoFramerate(int)} and {@link #setVideoEncodingBitrate(int)} and you're good to go.
* You can then call {@link #prepare()} & {@link #start()}.
* You can then call {@link #start()}.
* Call {@link #stop()} to stop the stream.
* Finally, do not forget to call {@link #release()} when you're done.
*/
public class H263Stream extends VideoStream {

Expand Down
3 changes: 1 addition & 2 deletions src/net/majorkernelpanic/streaming/video/H264Stream.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@
* A class for streaming H.264 from the camera of an android device using RTP.
* Call {@link #setDestinationAddress(java.net.InetAddress)}, {@link #setDestinationPorts(int)},
* {@link #setVideoSize(int, int)}, {@link #setVideoFramerate(int)} and {@link #setVideoEncodingBitrate(int)} and you're good to go.
* You can then call {@link #prepare()} & {@link #start()}.
* You can then call {@link #start()}.
* Call {@link #stop()} to stop the stream.
* Finally, do not forget to call {@link #release()} when you're done.
*/
public class H264Stream extends VideoStream {

Expand Down
18 changes: 9 additions & 9 deletions src/net/majorkernelpanic/streaming/video/VideoStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public VideoStream(int camera) {

/**
* Sets the camera that will be used to capture video.
* You can call this method at any time and changes will take effect next time you call {@link #prepare()}.
* You can call this method at any time and changes will take effect next time you start the stream.
* @param camera Can be either CameraInfo.CAMERA_FACING_BACK or CameraInfo.CAMERA_FACING_FRONT
*/
public void setCamera(int camera) {
Expand All @@ -94,8 +94,8 @@ public void setCamera(int camera) {
}

/** Switch between the front facing and the back facing camera of the phone.
* If {@link startPreview()} has been called, the preview will be briefly interrupted.
* If {@link start()} has been called, the stream will be briefly interrupted.
* If {@link #startPreview()} has been called, the preview will be briefly interrupted.
* If {@link #start()} has been called, the stream will be briefly interrupted.
* You should not call this method from the main thread if you are already streaming.
* @throws IOException
* @throws RuntimeException
Expand All @@ -117,7 +117,7 @@ public int getCamera() {

/**
* Sets a Surface to show a preview of recorded media (video).
* You can call this method at any time and changes will take effect next time you call {@link #prepare()}.
* You can call this method at any time and changes will take effect next time you call {@link #start()}.
*/
public synchronized void setPreviewDisplay(SurfaceHolder surfaceHolder) {
if (mSurfaceHolderCallback != null && mSurfaceHolder != null) {
Expand Down Expand Up @@ -200,7 +200,7 @@ public boolean getFlashState() {

/**
* Modifies the resolution of the stream. You can call this method at any time
* and changes will take effect next time you call {@link #prepare()}.
* and changes will take effect next time you call {@link #start()}.
* {@link #setVideoQuality(VideoQuality)} may be more convenient.
* @param width Width of the stream
* @param height height of the stream
Expand All @@ -214,7 +214,7 @@ public void setVideoSize(int width, int height) {

/**
* Modifies the framerate of the stream. You can call this method at any time
* and changes will take effect next time you call {@link #prepare()}.
* and changes will take effect next time you call {@link #start()}.
* {@link #setVideoQuality(VideoQuality)} may be more convenient.
* @param rate Framerate of the stream
*/
Expand All @@ -226,7 +226,7 @@ public void setVideoFramerate(int rate) {

/**
* Modifies the bitrate of the stream. You can call this method at any time
* and changes will take effect next time you call {@link #prepare()}.
* and changes will take effect next time you call {@link #start()}.
* {@link #setVideoQuality(VideoQuality)} may be more convenient.
* @param bitrate Bitrate of the stream in bit per second
*/
Expand All @@ -238,7 +238,7 @@ public void setVideoEncodingBitrate(int bitrate) {

/**
* Modifies the quality of the stream. You can call this method at any time
* and changes will take effect next time you call {@link #prepare()}.
* and changes will take effect next time you call {@link #start()}.
* @param videoQuality Quality of the stream
*/
public void setVideoQuality(VideoQuality videoQuality) {
Expand All @@ -249,7 +249,7 @@ public void setVideoQuality(VideoQuality videoQuality) {

/**
* Modifies the videoEncoder of the stream. You can call this method at any time
* and changes will take effect next time you call {@link #prepare()}.
* and changes will take effect next time you call {@link #start()}.
* @param videoEncoder Encoder of the stream
*/
protected void setVideoEncoder(int videoEncoder) {
Expand Down

0 comments on commit 7d8931f

Please sign in to comment.